-remove GNUNET_MQ_impl_send_commit, make it part of send_continue, to ensure calling...

[oweals/gnunet.git] / src / include / gnunet_scalarproduct_service.h

diff --git a/src/include/gnunet_scalarproduct_service.h b/src/include/gnunet_scalarproduct_service.h
index 3aac679c401956915df10dc0d7e613c58a457743..1146db1e4f46642f78eb6f82706058a87f99325a 100644 (file)
--- a/src/include/gnunet_scalarproduct_service.h
+++ b/src/include/gnunet_scalarproduct_service.h
@@ -45,17 +45,15 @@ enum GNUNET_SCALARPRODUCT_ResponseStatus
 {
   GNUNET_SCALARPRODUCT_Status_Success = 0,
   GNUNET_SCALARPRODUCT_Status_Failure,
-  GNUNET_SCALARPRODUCT_Status_Timeout,
   GNUNET_SCALARPRODUCT_Status_InvalidResponse,
   GNUNET_SCALARPRODUCT_Status_ServiceDisconnected
 };
 
+/**
+ * Opaque declaration of the SP-Handle
+ */
 struct GNUNET_SCALARPRODUCT_Handle;
 
-typedef void (*GNUNET_SCALARPRODUCT_ResponseMessageHandler) (void *cls,
-                                                             const struct GNUNET_MessageHeader *msg,
-                                                             enum GNUNET_SCALARPRODUCT_ResponseStatus status);
-
 /**
  * Continuation called to notify client about result of the
  * operation.
@@ -67,10 +65,10 @@ typedef void (*GNUNET_SCALARPRODUCT_ContinuationWithStatus) (void *cls,
                                                              enum GNUNET_SCALARPRODUCT_ResponseStatus status);
 /**
  * Process a datum that was stored in the scalarproduct.
- * 
+ *
  * @param cls closure
  * @param status Status of the request
- * @param type result of the computation
+ * @param result result of the computation
  */
 typedef void (*GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls,
                                                      enum GNUNET_SCALARPRODUCT_ResponseStatus status,
@@ -78,9 +76,9 @@ typedef void (*GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls,
 
 /**
  * Request by Alice's client for computing a scalar product
- * 
- * @param h handle to the master context
- * @param key Session key - unique to the requesting client
+ *
+ * @param cfg the gnunet configuration handle
+ * @param key Session key should be unique to the requesting client
  * @param peer PeerID of the other peer
  * @param elements Array of elements of the vector
  * @param element_count Number of elements in the vector
@@ -88,9 +86,11 @@ typedef void (*GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls,
  * @param mask_bytes number of bytes in the mask
  * @param cont Callback function
  * @param cont_cls Closure for the callback function
+ * 
+ * @return a new handle for this computation
  */
-struct GNUNET_SCALARPRODUCT_Handle *
-GNUNET_SCALARPRODUCT_request (const struct GNUNET_CONFIGURATION_Handle *h,
+struct GNUNET_SCALARPRODUCT_ComputationHandle *
+GNUNET_SCALARPRODUCT_request (const struct GNUNET_CONFIGURATION_Handle * cfg,
                               const struct GNUNET_HashCode * key,
                               const struct GNUNET_PeerIdentity *peer,
                               const int32_t * elements,
@@ -98,33 +98,42 @@ GNUNET_SCALARPRODUCT_request (const struct GNUNET_CONFIGURATION_Handle *h,
                               const unsigned char * mask,
                               uint32_t mask_bytes,
                               GNUNET_SCALARPRODUCT_DatumProcessor cont,
-                              void *cont_cls);
+                              void * cont_cls);
 
 /**
- * Used by Bob's client to cooperate with Alice, 
- * 
- * @param h handle to the master context
- * @param key Session key - unique to the requesting client
+ * Used by Bob's client to cooperate with Alice,
+ *
+ * @param cfg the gnunet configuration handle
+ * @param key Session key unique to the requesting client
  * @param elements Array of elements of the vector
  * @param element_count Number of elements in the vector
  * @param cont Callback function
  * @param cont_cls Closure for the callback function
+ * 
+ * @return a new handle for this computation
  */
-struct GNUNET_SCALARPRODUCT_Handle *
-GNUNET_SCALARPRODUCT_response (const struct GNUNET_CONFIGURATION_Handle *h,
+struct GNUNET_SCALARPRODUCT_ComputationHandle *
+GNUNET_SCALARPRODUCT_response (const struct GNUNET_CONFIGURATION_Handle * cfg,
                                const struct GNUNET_HashCode * key,
                                const int32_t * elements,
                                uint32_t element_count,
                                GNUNET_SCALARPRODUCT_ContinuationWithStatus cont,
-                               void *cont_cls);
+                               void * cont_cls);
 /**
  * Cancel an ongoing computation or revoke our collaboration offer.
  * Closes the connection to the service
- * 
- * @param h handel to terminate
+ *
+ * @param h computation handle to terminate
+ */
+void
+GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle * h);
+
+/**
+ * Cancel ALL ongoing computation or revoke our collaboration offer.
+ * Closes ALL connections to the service
  */
-void 
-GNUNET_SCALARPRODUCT_cancel (const struct GNUNET_SCALARPRODUCT_Handle *h);
+void
+GNUNET_SCALARPRODUCT_disconnect ();
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 {