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
*/
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,
gcry_mpi_t result);
+
/**
* 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
* @param mask Array of the mask
* @param mask_bytes number of bytes in the mask
* @param cont Callback function
- * @param cont_cls Closure for the callback function
+ * @param cont_cls Closure for @a cont
+ * @return a new handle for this computation
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_request (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_HashCode * key,
+ const struct GNUNET_HashCode *key,
const struct GNUNET_PeerIdentity *peer,
- const int32_t * elements,
+ const int32_t *elements,
uint32_t element_count,
- const unsigned char * mask,
+ 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 our configuration
- * @param key Session key - unique to the requesting client
+ * @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
+ * @param cont_cls Closure for @a cont
+ * @return a new handle for this computation
*/
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_response (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_HashCode * key,
- const int32_t * elements,
+ const struct GNUNET_HashCode *key,
+ const int32_t *elements,
uint32_t element_count,
GNUNET_SCALARPRODUCT_ContinuationWithStatus cont,
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);
+GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h);
+
/**
* Cancel ALL ongoing computation or revoke our collaboration offer.
* Closes ALL connections to the service
*
+ * FIXME: this should take an argument, and we should
+ * have an explicit 'connect' API which returns an opaque
+ * connection handle. Avoid (globals) in the library!
+ * @deprecated in this form
*/
void
GNUNET_SCALARPRODUCT_disconnect ();
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif