Scalar Product service

Data Structures
struct	GNUNET_SCALARPRODUCT_Element
	An element key-value pair for scalarproduct. More...

Macros
#define	GCRYPT_NO_DEPRECATED
#define	GNUNET_SCALARPRODUCT_VERSION   0x00000044
	Version of the scalarproduct API. More...

Typedefs
typedef void(*	GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status, gcry_mpi_t result)
	Process a datum that was stored in the scalarproduct. More...

Enumerations
enum	GNUNET_SCALARPRODUCT_ResponseStatus {   GNUNET_SCALARPRODUCT_STATUS_INIT = 0 , GNUNET_SCALARPRODUCT_STATUS_ACTIVE = 1 , GNUNET_SCALARPRODUCT_STATUS_SUCCESS , GNUNET_SCALARPRODUCT_STATUS_FAILURE ,   GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE , GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED }
	Result status values for the computation. More...

Functions
struct GNUNET_SCALARPRODUCT_ComputationHandle *	GNUNET_SCALARPRODUCT_start_computation (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *session_key, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count, GNUNET_SCALARPRODUCT_DatumProcessor cont, void *cont_cls)
	Request by Alice's client for computing a scalar product. More...
struct GNUNET_SCALARPRODUCT_ComputationHandle *	GNUNET_SCALARPRODUCT_accept_computation (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_HashCode *session_key, const struct GNUNET_SCALARPRODUCT_Element *elements, uint32_t element_count, GNUNET_SCALARPRODUCT_ContinuationWithStatus cont, void *cont_cls)
	Used by Bob's client to cooperate with Alice,. More...
void	GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h)
	Cancel an ongoing computation or revoke our collaboration offer. More...

Variables
GNUNET_NETWORK_STRUCT_END typedef void(*	GNUNET_SCALARPRODUCT_ContinuationWithStatus )(void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status)
	Continuation called to notify client about result of the operation. More...

Detailed Description

Macro Definition Documentation

GCRYPT_NO_DEPRECATED

#define GCRYPT_NO_DEPRECATED

Definition at line 33 of file gnunet_scalarproduct_service.h.

GNUNET_SCALARPRODUCT_VERSION

#define GNUNET_SCALARPRODUCT_VERSION   0x00000044

Version of the scalarproduct API.

Definition at line 47 of file gnunet_scalarproduct_service.h.

Typedef Documentation

GNUNET_SCALARPRODUCT_DatumProcessor

typedef void(* GNUNET_SCALARPRODUCT_DatumProcessor) (void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status, gcry_mpi_t result)

Process a datum that was stored in the scalarproduct.

Parameters

cls	closure
status	Status of the request
result	result of the computation

Definition at line 133 of file gnunet_scalarproduct_service.h.

Enumeration Type Documentation

GNUNET_SCALARPRODUCT_ResponseStatus

enum GNUNET_SCALARPRODUCT_ResponseStatus

Result status values for the computation.

Enumerator
GNUNET_SCALARPRODUCT_STATUS_INIT	Operation is still active (never returned, used internally).
GNUNET_SCALARPRODUCT_STATUS_ACTIVE	Operation is still active (never returned, used internally).
GNUNET_SCALARPRODUCT_STATUS_SUCCESS	The computation was successful.
GNUNET_SCALARPRODUCT_STATUS_FAILURE	We encountered some error.
GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE	We got an invalid response.
GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED	We got disconnected from the SCALARPRODUCT service.

Definition at line 52 of file gnunet_scalarproduct_service.h.

{
  GNUNET_SCALARPRODUCT_STATUS_INIT = 0,
 
  GNUNET_SCALARPRODUCT_STATUS_ACTIVE = 1,
 
  GNUNET_SCALARPRODUCT_STATUS_SUCCESS,
 
  GNUNET_SCALARPRODUCT_STATUS_FAILURE,
 
  GNUNET_SCALARPRODUCT_STATUS_INVALID_RESPONSE,
 
  GNUNET_SCALARPRODUCT_STATUS_DISCONNECTED
};

Function Documentation

GNUNET_SCALARPRODUCT_start_computation()

struct GNUNET_SCALARPRODUCT_ComputationHandle* GNUNET_SCALARPRODUCT_start_computation	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		const struct GNUNET_HashCode *	session_key,
		const struct GNUNET_PeerIdentity *	peer,
		const struct GNUNET_SCALARPRODUCT_Element *	elements,
		uint32_t	element_count,
		GNUNET_SCALARPRODUCT_DatumProcessor	cont,
		void *	cont_cls
	)

Request by Alice's client for computing a scalar product.

Parameters

cfg	the gnunet configuration handle
session_key	Session key should be unique to the requesting client
peer	PeerID of the other peer
elements	Array of elements of the vector
element_count	Number of elements in the elements vector
cont	Callback function
cont_cls	Closure for the cont callback function

Returns

a new handle for this computation

Definition at line 361 of file scalarproduct_api.c.

{
  struct GNUNET_SCALARPRODUCT_ComputationHandle *h
    = GNUNET_new (struct GNUNET_SCALARPRODUCT_ComputationHandle);
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (response,
                           GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT,
                           struct ClientResponseMessage,
                           h),
    GNUNET_MQ_handler_end ()
  };
  struct GNUNET_MQ_Envelope *env;
  struct AliceComputationMessage *msg;
  struct ComputationBobCryptodataMultipartMessage *mmsg;
  uint32_t size;
  uint16_t possible;
  uint16_t todo;
  uint32_t element_count_transfered;
 
  if (GNUNET_SYSERR == check_unique (elements,
                                     element_count))
    return NULL;
  h->mq = GNUNET_CLIENT_connect (cfg,
                                 "scalarproduct-alice",
                                 handlers,
                                 &mq_error_handler,
                                 h);
  if (NULL == h->mq)
  {
    /* misconfigured scalarproduct service */
    GNUNET_break (0);
    GNUNET_free (h);
    return NULL;
  }
  h->cont_datum = cont;
  h->cont_cls = cont_cls;
  h->response_proc = &process_result_message;
  h->cfg = cfg;
  h->key = *session_key;
 
  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(struct
                                                   AliceComputationMessage))
             / sizeof(struct GNUNET_SCALARPRODUCT_Element);
  todo = GNUNET_MIN (possible,
                     element_count);
  size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
  env = GNUNET_MQ_msg_extra (msg,
                             size,
                             GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE);
  msg->element_count_total = htonl (element_count);
  msg->element_count_contained = htonl (todo);
  msg->reserved = htonl (0);
  msg->peer = *peer;
  msg->session_key = *session_key;
  GNUNET_memcpy (&msg[1],
                 elements,
                 size);
  GNUNET_MQ_send (h->mq,
                  env);
  element_count_transfered = todo;
  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(*mmsg))
             / sizeof(struct GNUNET_SCALARPRODUCT_Element);
  while (element_count_transfered < element_count)
  {
    todo = GNUNET_MIN (possible,
                       element_count - element_count_transfered);
    size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
    env = GNUNET_MQ_msg_extra (mmsg,
                               size,
                               GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_ALICE);
    mmsg->element_count_contained = htonl (todo);
    GNUNET_memcpy (&mmsg[1],
                   &elements[element_count_transfered],
                   size);
    element_count_transfered += todo;
    GNUNET_MQ_send (h->mq,
                    env);
  }
  return h;
}

References cfg, GNUNET_ARM_Handle::cfg, check_unique(), ComputationBobCryptodataMultipartMessage::element_count_contained, env, GNUNET_break, GNUNET_CLIENT_connect(), GNUNET_free, GNUNET_MAX_MESSAGE_SIZE, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_ALICE, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT, GNUNET_MIN, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, GNUNET_SYSERR, h, handlers, GNUNET_ARM_Handle::mq, mq_error_handler(), msg, peer, process_result_message(), response, session_key, and size.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_SCALARPRODUCT_accept_computation()

struct GNUNET_SCALARPRODUCT_ComputationHandle* GNUNET_SCALARPRODUCT_accept_computation	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		const struct GNUNET_HashCode *	session_key,
		const struct GNUNET_SCALARPRODUCT_Element *	elements,
		uint32_t	element_count,
		GNUNET_SCALARPRODUCT_ContinuationWithStatus	cont,
		void *	cont_cls
	)

Used by Bob's client to cooperate with Alice,.

Parameters

cfg	the gnunet configuration handle
session_key	Session key unique to the requesting client
elements	Array of elements of the vector
element_count	Number of elements in the elements vector
cont	Callback function
cont_cls	Closure for the cont callback function

Returns

a new handle for this computation

Definition at line 214 of file scalarproduct_api.c.

{
  struct GNUNET_SCALARPRODUCT_ComputationHandle *h
    = GNUNET_new (struct GNUNET_SCALARPRODUCT_ComputationHandle);
  struct GNUNET_MQ_MessageHandler handlers[] = {
    GNUNET_MQ_hd_var_size (response,
                           GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT,
                           struct ClientResponseMessage,
                           h),
    GNUNET_MQ_handler_end ()
  };
  struct GNUNET_MQ_Envelope *env;
  struct BobComputationMessage *msg;
  struct ComputationBobCryptodataMultipartMessage *mmsg;
  uint32_t size;
  uint16_t possible;
  uint16_t todo;
  uint32_t element_count_transfered;
 
 
  if (GNUNET_SYSERR == check_unique (elements,
                                     element_count))
    return NULL;
  h->cont_status = cont;
  h->cont_cls = cont_cls;
  h->response_proc = &process_status_message;
  h->cfg = cfg;
  h->key = *session_key;
  h->mq = GNUNET_CLIENT_connect (cfg,
                                 "scalarproduct-bob",
                                 handlers,
                                 &mq_error_handler,
                                 h);
  if (NULL == h->mq)
  {
    /* scalarproduct configuration error */
    GNUNET_break (0);
    GNUNET_free (h);
    return NULL;
  }
  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(struct
                                                   BobComputationMessage))
             / sizeof(struct GNUNET_SCALARPRODUCT_Element);
  todo = GNUNET_MIN (possible,
                     element_count);
  size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
  env = GNUNET_MQ_msg_extra (msg,
                             size,
                             GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB);
  msg->element_count_total = htonl (element_count);
  msg->element_count_contained = htonl (todo);
  msg->session_key = *session_key;
  GNUNET_memcpy (&msg[1],
                 elements,
                 size);
  element_count_transfered = todo;
  GNUNET_MQ_send (h->mq,
                  env);
  possible = (GNUNET_MAX_MESSAGE_SIZE - 1 - sizeof(*mmsg))
             / sizeof(struct GNUNET_SCALARPRODUCT_Element);
  while (element_count_transfered < element_count)
  {
    todo = GNUNET_MIN (possible,
                       element_count - element_count_transfered);
    size = todo * sizeof(struct GNUNET_SCALARPRODUCT_Element);
    env = GNUNET_MQ_msg_extra (mmsg,
                               size,
                               GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_BOB);
    mmsg->element_count_contained = htonl (todo);
    GNUNET_memcpy (&mmsg[1],
                   &elements[element_count_transfered],
                   size);
    element_count_transfered += todo;
    GNUNET_MQ_send (h->mq,
                    env);
  }
  return h;
}

References cfg, GNUNET_ARM_Handle::cfg, check_unique(), ComputationBobCryptodataMultipartMessage::element_count_contained, env, GNUNET_break, GNUNET_CLIENT_connect(), GNUNET_free, GNUNET_MAX_MESSAGE_SIZE, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_MULTIPART_BOB, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB, GNUNET_MESSAGE_TYPE_SCALARPRODUCT_RESULT, GNUNET_MIN, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, GNUNET_SYSERR, h, handlers, GNUNET_ARM_Handle::mq, mq_error_handler(), msg, process_status_message(), response, session_key, and size.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_SCALARPRODUCT_cancel()

void GNUNET_SCALARPRODUCT_cancel

(

struct GNUNET_SCALARPRODUCT_ComputationHandle *

h

)

Cancel an ongoing computation or revoke our collaboration offer.

Closes the connection to the service

Parameters

h	computation handle to terminate

Definition at line 457 of file scalarproduct_api.c.

{
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  GNUNET_free (h);
}

References GNUNET_free, GNUNET_MQ_destroy(), h, and GNUNET_ARM_Handle::mq.

Referenced by process_result_message(), process_status_message(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

GNUNET_SCALARPRODUCT_ContinuationWithStatus

GNUNET_NETWORK_STRUCT_END typedef void(* GNUNET_SCALARPRODUCT_ContinuationWithStatus) (void *cls, enum GNUNET_SCALARPRODUCT_ResponseStatus status)	(	void *	cls,
		enum GNUNET_SCALARPRODUCT_ResponseStatus	status
	)

Continuation called to notify client about result of the operation.

Parameters

cls	closure
status	Status of the request

Definition at line 120 of file gnunet_scalarproduct_service.h.