GNUnet  0.18.1
MQ library

General-purpose message queue. More...

Collaboration diagram for MQ library:

Data Structures

struct  GNUNET_MQ_MessageHandler
 Message handler for a specific message type. More...
 

Macros

#define GNUNET_MQ_msg_extra(mvar, esize, type)
 Allocate an envelope, with extra space allocated after the space needed by the message struct. More...
 
#define GNUNET_MQ_msg(mvar, type)   GNUNET_MQ_msg_extra (mvar, 0, type)
 Allocate a GNUNET_MQ_Envelope. More...
 
#define GNUNET_MQ_msg_header(type)    GNUNET_MQ_msg_ (NULL, sizeof(struct GNUNET_MessageHeader), type)
 Allocate a GNUNET_MQ_Envelope, where the message only consists of a header. More...
 
#define GNUNET_MQ_msg_header_extra(mh, esize, type)    GNUNET_MQ_msg_ (&mh, (esize) + sizeof(struct GNUNET_MessageHeader), type)
 Allocate a GNUNET_MQ_Envelope, where the message only consists of a header and extra space. More...
 
#define GNUNET_MQ_msg_nested_mh(mvar, type, mh)
 Allocate a GNUNET_MQ_Envelope, and append a payload message after the given message struct. More...
 
#define GNUNET_MQ_extract_nested_mh(var)
 Return a pointer to the message at the end of the given message. More...
 
#define GNUNET_MQ_handler_end()
 End-marker for the handlers array. More...
 

Typedefs

typedef void(* GNUNET_MQ_MessageCallback) (void *cls, const struct GNUNET_MessageHeader *msg)
 Called when a message has been received. More...
 
typedef int(* GNUNET_MQ_MessageValidationCallback) (void *cls, const struct GNUNET_MessageHeader *msg)
 Called when a message needs to be validated. More...
 
typedef void(* GNUNET_MQ_SendImpl) (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)
 Signature of functions implementing the sending functionality of a message queue. More...
 
typedef void(* GNUNET_MQ_DestroyImpl) (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Signature of functions implementing the destruction of a message queue. More...
 
typedef void(* GNUNET_MQ_CancelImpl) (struct GNUNET_MQ_Handle *mq, void *impl_state)
 Implementation function that cancels the currently sent message. More...
 
typedef void(* GNUNET_MQ_ErrorHandler) (void *cls, enum GNUNET_MQ_Error error)
 Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue. More...
 

Enumerations

enum  GNUNET_MQ_Error {
  GNUNET_MQ_ERROR_READ = 1 , GNUNET_MQ_ERROR_WRITE = 2 , GNUNET_MQ_ERROR_TIMEOUT = 4 , GNUNET_MQ_ERROR_MALFORMED = 8 ,
  GNUNET_MQ_ERROR_NO_MATCH = 16
}
 Error codes for the queue. More...
 
enum  GNUNET_MQ_PriorityPreferences {
  GNUNET_MQ_PRIO_BACKGROUND = 0 , GNUNET_MQ_PRIO_BEST_EFFORT = 1 , GNUNET_MQ_PRIO_URGENT = 2 , GNUNET_MQ_PRIO_CRITICAL_CONTROL = 3 ,
  GNUNET_MQ_PRIORITY_MASK = 3 , GNUNET_MQ_PREF_UNRELIABLE = 16 , GNUNET_MQ_PREF_LOW_LATENCY = 32 , GNUNET_MQ_PREF_CORK_ALLOWED = 64 ,
  GNUNET_MQ_PREF_GOODPUT = 128 , GNUNET_MQ_PREF_OUT_OF_ORDER = 256
}
 Per envelope preferences and priorities. More...
 

Functions

const struct GNUNET_MessageHeaderGNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh, uint16_t base_size)
 Implementation of the #GNUNET_MQ_extract_nexted_mh macro. More...
 
const struct GNUNET_MessageHeaderGNUNET_MQ_env_get_msg (const struct GNUNET_MQ_Envelope *env)
 Obtain message contained in envelope. More...
 
const struct GNUNET_MQ_EnvelopeGNUNET_MQ_env_next (const struct GNUNET_MQ_Envelope *env)
 Return next envelope in queue. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_msg_nested_mh_ (struct GNUNET_MessageHeader **mhp, uint16_t base_size, uint16_t type, const struct GNUNET_MessageHeader *nested_mh)
 Implementation of the GNUNET_MQ_msg_nested_mh macro. More...
 
void GNUNET_MQ_dll_insert_head (struct GNUNET_MQ_Envelope **env_head, struct GNUNET_MQ_Envelope **env_tail, struct GNUNET_MQ_Envelope *env)
 Insert env into the envelope DLL starting at env_head Note that env must not be in any MQ while this function is used with DLLs defined outside of the MQ module. More...
 
void GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope **env_head, struct GNUNET_MQ_Envelope **env_tail, struct GNUNET_MQ_Envelope *env)
 Insert env into the envelope DLL starting at env_head Note that env must not be in any MQ while this function is used with DLLs defined outside of the MQ module. More...
 
void GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head, struct GNUNET_MQ_Envelope **env_tail, struct GNUNET_MQ_Envelope *env)
 Remove env from the envelope DLL starting at env_head. More...
 
struct GNUNET_MQ_MessageHandlerGNUNET_MQ_copy_handlers (const struct GNUNET_MQ_MessageHandler *handlers)
 Copy an array of handlers. More...
 
struct GNUNET_MQ_MessageHandlerGNUNET_MQ_copy_handlers2 (const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_MessageCallback agpl_handler, void *agpl_cls)
 Copy an array of handlers, appending AGPL handler. More...
 
unsigned int GNUNET_MQ_count_handlers (const struct GNUNET_MQ_MessageHandler *handlers)
 Count the handlers in a handler array. More...
 
struct GNUNET_NotificationContextGNUNET_notification_context_create (unsigned int queue_length)
 Create a new notification context. More...
 
void GNUNET_notification_context_destroy (struct GNUNET_NotificationContext *nc)
 Destroy the context, force disconnect for all subscribers. More...
 
void GNUNET_notification_context_add (struct GNUNET_NotificationContext *nc, struct GNUNET_MQ_Handle *mq)
 Add a subscriber to the notification context. More...
 
void GNUNET_notification_context_broadcast (struct GNUNET_NotificationContext *nc, const struct GNUNET_MessageHeader *msg, int can_drop)
 Send a message to all subscribers of this context. More...
 
unsigned int GNUNET_notification_context_get_size (struct GNUNET_NotificationContext *nc)
 Return active number of subscribers in this context. More...
 

will return a <tt>struct

Defines a static function name which takes two arguments and a context-pointer for validating and handling variable-sized messages of type code and with a message type argument of str.

Given such arguments, the function GNUNET_MQ_MessageHandler for the given message type.

The macro is to be used as follows: struct GNUNET_MessageTest { ... }; // can be variable size static int check_test (void *cls, const struct GNUNET_MessageTest *msg) { const char *ctx = cls; GNUNET_assert (0 == strcmp ("context", ctx)); // ... } static void handle_test (void *cls, const struct GNUNET_MessageTest *msg) { const char *ctx = cls; GNUNET_assert (0 == strcmp ("context", ctx)); // ... }

struct GNUNET_MQ_MessageHandler handlers[] = { GNUNET_MQ_hd_var_size(test_message, GNUNET_MESSAGE_TYPE_TEST, struct GNUNET_MessageTest, "context"), GNUNET_MQ_handler_end() };

Parameters
nameunique basename for the functions
codemessage type constant
strtype of the message (a struct)
ctxcontext for the callbacks
enum  GNUNET_MQ_PreferenceKind { GNUNET_MQ_PREFERENCE_NONE = 0 , GNUNET_MQ_PREFERENCE_BANDWIDTH = 1 , GNUNET_MQ_PREFERENCE_LATENCY = 2 , GNUNET_MQ_PREFERENCE_RELIABILITY }
 Enum defining all known preference categories. More...
 
int GNUNET_MQ_handle_message (const struct GNUNET_MQ_MessageHandler *handlers, const struct GNUNET_MessageHeader *mh)
 Call the message message handler that was registered for the type of the given message in the given handlers list. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_msg_ (struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type)
 Create a new envelope. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_msg_copy (const struct GNUNET_MessageHeader *hdr)
 Create a new envelope by copying an existing message. More...
 
void GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *mqm)
 Discard the message queue message, free all allocated resources. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_get_current_envelope (struct GNUNET_MQ_Handle *mq)
 Function to obtain the current envelope from within GNUNET_MQ_SendImpl implementations. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_env_copy (struct GNUNET_MQ_Envelope *env)
 Function to copy an envelope. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_get_last_envelope (struct GNUNET_MQ_Handle *mq)
 Function to obtain the last envelope in the queue. More...
 
void GNUNET_MQ_env_set_options (struct GNUNET_MQ_Envelope *env, enum GNUNET_MQ_PriorityPreferences pp)
 Set application-specific options for this envelope. More...
 
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_get_options (struct GNUNET_MQ_Envelope *env)
 Get performance preferences set for this envelope. More...
 
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_combine_options (enum GNUNET_MQ_PriorityPreferences p1, enum GNUNET_MQ_PriorityPreferences p2)
 Combine performance preferences set for different envelopes that are being combined into one larger envelope. More...
 
struct GNUNET_MQ_EnvelopeGNUNET_MQ_unsent_head (struct GNUNET_MQ_Handle *mq)
 Remove the first envelope that has not yet been sent from the message queue and return it. More...
 
void GNUNET_MQ_set_options (struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_PriorityPreferences pp)
 Set application-specific options for this queue. More...
 
unsigned int GNUNET_MQ_get_length (struct GNUNET_MQ_Handle *mq)
 Obtain the current length of the message queue. More...
 
void GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
 Send a message with the given message queue. More...
 
void GNUNET_MQ_send_copy (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MQ_Envelope *ev)
 Send a copy of a message with the given message queue. More...
 
void GNUNET_MQ_send_cancel (struct GNUNET_MQ_Envelope *ev)
 Cancel sending the message. More...
 
uint32_t GNUNET_MQ_assoc_add (struct GNUNET_MQ_Handle *mq, void *assoc_data)
 Associate the assoc_data in mq with a unique request id. More...
 
void * GNUNET_MQ_assoc_get (struct GNUNET_MQ_Handle *mq, uint32_t request_id)
 Get the data associated with a request_id in a queue. More...
 
void * GNUNET_MQ_assoc_remove (struct GNUNET_MQ_Handle *mq, uint32_t request_id)
 Remove the association for a request_id. More...
 
struct GNUNET_MQ_HandleGNUNET_MQ_queue_for_callbacks (GNUNET_MQ_SendImpl send, GNUNET_MQ_DestroyImpl destroy, GNUNET_MQ_CancelImpl cancel, void *impl_state, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_MQ_ErrorHandler error_handler, void *cls)
 Create a message queue for the specified handlers. More...
 
void GNUNET_MQ_set_handlers_closure (struct GNUNET_MQ_Handle *mq, void *handlers_cls)
 Change the closure argument in all of the handlers of the mq. More...
 
void GNUNET_MQ_notify_sent (struct GNUNET_MQ_Envelope *ev, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
 Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore. More...
 
void GNUNET_MQ_destroy (struct GNUNET_MQ_Handle *mq)
 Destroy the message queue. More...
 
struct GNUNET_MQ_DestroyNotificationHandleGNUNET_MQ_destroy_notify (struct GNUNET_MQ_Handle *mq, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
 Register function to be called whenever mq is being destroyed. More...
 
void GNUNET_MQ_destroy_notify_cancel (struct GNUNET_MQ_DestroyNotificationHandle *dnh)
 Cancel registration from GNUNET_MQ_destroy_notify(). More...
 
void GNUNET_MQ_inject_message (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *mh)
 Call the message message handler that was registered for the type of the given message in the given message queue. More...
 
void GNUNET_MQ_inject_error (struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_Error error)
 Call the error handler of a message queue with the given error code. More...
 
void GNUNET_MQ_impl_send_continue (struct GNUNET_MQ_Handle *mq)
 Call the send implementation for the next queued message, if any. More...
 
void GNUNET_MQ_impl_send_in_flight (struct GNUNET_MQ_Handle *mq)
 Call the send notification for the current message, but do not try to send the next message until #gnunet_mq_impl_send_continue is called. More...
 
void * GNUNET_MQ_impl_state (struct GNUNET_MQ_Handle *mq)
 Get the implementation state associated with the message queue. More...
 
const struct GNUNET_MessageHeaderGNUNET_MQ_impl_current (struct GNUNET_MQ_Handle *mq)
 Get the message that should currently be sent. More...
 
const char * GNUNET_MQ_preference_to_string (enum GNUNET_MQ_PreferenceKind type)
 Convert an enum GNUNET_MQ_PreferenceType to a string. More...
 
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
 
#define GNUNET_MQ_check_zero_termination(m)
 Insert code for a "check_" function that verifies that a given variable-length message received over the network is followed by a 0-terminated string. More...
 
#define GNUNET_MQ_check_boxed_message(m)
 Insert code for a "check_" function that verifies that a given variable-length message received over the network is followed by another variable-length message that fits exactly with the given size. More...
 

will return a <tt>struct GNUNET_MQ_MessageHandler</tt>

Defines a static function name which takes as a single argument a message handler for fixed-sized messages of type code and with a message type argument of str.

Given such an argument, the function for the given message type.

The macro is to be used as follows: struct GNUNET_MessageTest { ... }; // must be fixed size static void handle_test_message (void *cls, const struct GNUNET_MessageTest *msg) { ... }

struct GNUNET_MQ_MessageHandler handlers[] = { GNUNET_MQ_hd_fixed_size(test_message, GNUNET_MESSAGE_TYPE_TEST, struct GNUNET_MessageTest, "context"), GNUNET_MQ_handler_end() };

Parameters
nameunique basename for the functions
codemessage type constant
strtype of the message (a struct)
ctxcontext for the callbacks

#define GNUNET_MQ_hd_fixed_size(name, code, str, ctx)
 

Detailed Description

General-purpose message queue.

General-purpose broadcast mechanism for message queues.

See also
Documentation
Documentation

Macro Definition Documentation

◆ GNUNET_MQ_msg_extra

#define GNUNET_MQ_msg_extra (   mvar,
  esize,
  type 
)
Value:
GNUNET_MQ_msg_ (((struct GNUNET_MessageHeader **) &(mvar)), \
(esize) + sizeof *(mvar), \
(type))
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_(struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type)
Create a new envelope.
Definition: mq.c:519
Header for all communications.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model

Allocate an envelope, with extra space allocated after the space needed by the message struct.

The allocated message will already have the type and size field set.

Parameters
mvarvariable to store the allocated message in; must have a header field; can be NULL
esizeextra space to allocate after the message
typetype of the message
Returns
the MQ message

Definition at line 56 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_msg

#define GNUNET_MQ_msg (   mvar,
  type 
)    GNUNET_MQ_msg_extra (mvar, 0, type)

Allocate a GNUNET_MQ_Envelope.

The contained message will already have the type and size field set.

Parameters
mvarvariable to store the allocated message in; must have a header field; can be NULL
typetype of the message
Returns
the allocated envelope

Definition at line 71 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_msg_header

#define GNUNET_MQ_msg_header (   type)     GNUNET_MQ_msg_ (NULL, sizeof(struct GNUNET_MessageHeader), type)

Allocate a GNUNET_MQ_Envelope, where the message only consists of a header.

The allocated message will already have the type and size field set.

Parameters
typetype of the message

Definition at line 80 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_msg_header_extra

#define GNUNET_MQ_msg_header_extra (   mh,
  esize,
  type 
)     GNUNET_MQ_msg_ (&mh, (esize) + sizeof(struct GNUNET_MessageHeader), type)

Allocate a GNUNET_MQ_Envelope, where the message only consists of a header and extra space.

The allocated message will already have the type and size field set.

Parameters
mhpointer that will changed to point at to the allocated message header
esizeextra space to allocate after the message header
typetype of the message

Definition at line 92 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_msg_nested_mh

#define GNUNET_MQ_msg_nested_mh (   mvar,
  type,
  mh 
)
Value:
({ \
struct GNUNET_MQ_Envelope *_ev; \
_ev = GNUNET_MQ_msg_nested_mh_ ((struct GNUNET_MessageHeader **) &(mvar), \
sizeof(*(mvar)), \
(type), \
(mh)); \
(void) (mvar)->header; /* type check */ \
_ev; \
})
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_nested_mh_(struct GNUNET_MessageHeader **mhp, uint16_t base_size, uint16_t type, const struct GNUNET_MessageHeader *nested_mh)
Implementation of the GNUNET_MQ_msg_nested_mh macro.
Definition: mq.c:551

Allocate a GNUNET_MQ_Envelope, and append a payload message after the given message struct.

Parameters
mvarpointer to a message struct, will be changed to point at the newly allocated message, whose size is 'sizeof(*mvar) + ntohs (mh->size)'
typemessage type of the allocated message, has no effect on the nested message
mhmessage to nest
Returns
a newly allocated 'struct GNUNET_MQ_Envelope *'

Definition at line 106 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_extract_nested_mh

#define GNUNET_MQ_extract_nested_mh (   var)
Value:
sizeof(*(var)))
const struct GNUNET_MessageHeader * GNUNET_MQ_extract_nested_mh_(const struct GNUNET_MessageHeader *mh, uint16_t base_size)
Implementation of the #GNUNET_MQ_extract_nexted_mh macro.
Definition: mq.c:743

Return a pointer to the message at the end of the given message.

Parameters
varpointer to a message struct, the type of the expression determines the base size, the space after the base size is the nested message
Returns
a 'struct GNUNET_MessageHeader *' that points at the nested message of the given message, or NULL if the given message in var does not have any space after the message struct

Definition at line 126 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_handler_end

#define GNUNET_MQ_handler_end ( )
Value:
{ \
NULL, NULL, NULL, 0, 0 \
}

End-marker for the handlers array.

Definition at line 525 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_hd_fixed_size

#define GNUNET_MQ_hd_fixed_size (   name,
  code,
  str,
  ctx 
)
Value:
({ \
void (*_cb)(void *cls, const str *msg) = &handle_ ## name; \
((struct GNUNET_MQ_MessageHandler){ NULL, \
(ctx), \
(code), \
sizeof(str) }); \
})
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
void(* GNUNET_MQ_MessageCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message has been received.
const char * name
Message handler for a specific message type.

Definition at line 559 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_hd_var_size

#define GNUNET_MQ_hd_var_size (   name,
  code,
  str,
  ctx 
)
Value:
__extension__ ({ \
int (*_mv)(void *cls, const str *msg) = &check_ ## name; \
void (*_cb)(void *cls, const str *msg) = &handle_ ## name; \
_mv, \
(ctx), \
(code), \
sizeof(str) }); \
})
int(* GNUNET_MQ_MessageValidationCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message needs to be validated.

Definition at line 611 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_check_zero_termination

#define GNUNET_MQ_check_zero_termination (   m)
Value:
{ \
const char *str = (const char *) &m[1]; \
const struct GNUNET_MessageHeader *hdr = \
(const struct GNUNET_MessageHeader *) m; \
uint16_t slen = ntohs (hdr->size) - sizeof(*m); \
if ((0 == slen) || (memchr (str, 0, slen) != &str[slen - 1])) \
{ \
GNUNET_break (0); \
return GNUNET_NO; \
} \
}
static struct GNUNET_ARM_MonitorHandle * m
Monitor connection with ARM.
Definition: gnunet-arm.c:104
@ GNUNET_NO
Definition: gnunet_common.h:98
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format.

Insert code for a "check_" function that verifies that a given variable-length message received over the network is followed by a 0-terminated string.

If the message m is not followed by a 0-terminated string, an error is logged and the function is returned with GNUNET_NO.

Parameters
anIPC message with proper type to determine the size, starting with a struct GNUNET_MessageHeader

Definition at line 634 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_check_boxed_message

#define GNUNET_MQ_check_boxed_message (   m)
Value:
{ \
const struct GNUNET_MessageHeader *inbox = \
(const struct GNUNET_MessageHeader *) &m[1]; \
const struct GNUNET_MessageHeader *hdr = \
(const struct GNUNET_MessageHeader *) m; \
uint16_t slen = ntohs (hdr->size) - sizeof(*m); \
if ((slen < sizeof(struct GNUNET_MessageHeader)) || \
(slen != ntohs (inbox->size))) \
{ \
GNUNET_break (0); \
return GNUNET_NO; \
} \
}

Insert code for a "check_" function that verifies that a given variable-length message received over the network is followed by another variable-length message that fits exactly with the given size.

If the message m is not followed by another struct GNUNET_MessageHeader with a size that adds up to the total size, an error is logged and the function is returned with GNUNET_NO.

Parameters
anIPC message with proper type to determine the size, starting with a struct GNUNET_MessageHeader

Definition at line 660 of file gnunet_mq_lib.h.

Typedef Documentation

◆ GNUNET_MQ_MessageCallback

typedef void(* GNUNET_MQ_MessageCallback) (void *cls, const struct GNUNET_MessageHeader *msg)

Called when a message has been received.

Parameters
clsclosure
msgthe received message

Definition at line 312 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_MessageValidationCallback

typedef int(* GNUNET_MQ_MessageValidationCallback) (void *cls, const struct GNUNET_MessageHeader *msg)

Called when a message needs to be validated.

Parameters
clsclosure
msgthe received message
Returns
GNUNET_OK if the message is well-formed, GNUNET_SYSERR if not

Definition at line 326 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_SendImpl

typedef void(* GNUNET_MQ_SendImpl) (struct GNUNET_MQ_Handle *mq, const struct GNUNET_MessageHeader *msg, void *impl_state)

Signature of functions implementing the sending functionality of a message queue.

Parameters
mqthe message queue
msgthe message to send
impl_statestate of the implementation

Definition at line 340 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_DestroyImpl

typedef void(* GNUNET_MQ_DestroyImpl) (struct GNUNET_MQ_Handle *mq, void *impl_state)

Signature of functions implementing the destruction of a message queue.

Implementations must not free mq, but should take care of impl_state.

Parameters
mqthe message queue to destroy
impl_statestate of the implementation

Definition at line 355 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_CancelImpl

typedef void(* GNUNET_MQ_CancelImpl) (struct GNUNET_MQ_Handle *mq, void *impl_state)

Implementation function that cancels the currently sent message.

Parameters
mqmessage queue
impl_statestate specific to the implementation

Definition at line 366 of file gnunet_mq_lib.h.

◆ GNUNET_MQ_ErrorHandler

typedef void(* GNUNET_MQ_ErrorHandler) (void *cls, enum GNUNET_MQ_Error error)

Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.

Not every message queue implementation supports an error handler.

Parameters
clsclosure
errorerror code

Definition at line 380 of file gnunet_mq_lib.h.

Enumeration Type Documentation

◆ GNUNET_MQ_Error

Error codes for the queue.

Enumerator
GNUNET_MQ_ERROR_READ 

Failed to read message from the network.

FIXME: Likely not properly distinguished from TIMEOUT case in the code!

GNUNET_MQ_ERROR_WRITE 

FIXME: document!

GNUNET_MQ_ERROR_TIMEOUT 

FIXME: document!

GNUNET_MQ_ERROR_MALFORMED 

We received a message that was malformed and thus could not be passed to its handler.

GNUNET_MQ_ERROR_NO_MATCH 

We received a message for which we have no matching handler.

Definition at line 195 of file gnunet_mq_lib.h.

196 {
203 
208 
213 
219 
225 };
@ GNUNET_MQ_ERROR_READ
Failed to read message from the network.
@ GNUNET_MQ_ERROR_NO_MATCH
We received a message for which we have no matching handler.
@ GNUNET_MQ_ERROR_TIMEOUT
FIXME: document!
@ GNUNET_MQ_ERROR_MALFORMED
We received a message that was malformed and thus could not be passed to its handler.
@ GNUNET_MQ_ERROR_WRITE
FIXME: document!

◆ GNUNET_MQ_PriorityPreferences

Per envelope preferences and priorities.

Enumerator
GNUNET_MQ_PRIO_BACKGROUND 

Lowest priority, i.e.

background traffic (e.g. NSE, FS). This is the default!

GNUNET_MQ_PRIO_BEST_EFFORT 

Best-effort traffic (e.g.

CADET relay, DHT)

GNUNET_MQ_PRIO_URGENT 

Urgent traffic (local peer, e.g.

Conversation).

GNUNET_MQ_PRIO_CRITICAL_CONTROL 

Highest priority, control traffic (e.g.

CORE/CADET KX).

GNUNET_MQ_PRIORITY_MASK 

Bit mask to apply to extract the priority bits.

GNUNET_MQ_PREF_UNRELIABLE 

Flag to indicate that unreliable delivery is acceptable.

This means TRANSPORT will not attempt to receive an acknowledgment. CORE will just pass this flag through. CADET will use unreliable delivery if this flag is set.

Note that even without this flag, messages may be lost by TRANSPORT and CORE.

Thus, how "strong" the semantics of reliable delivery are depends on the layer!

GNUNET_MQ_PREF_LOW_LATENCY 

Flag to indicate that low latency is important.

This flag must generally not be used in combination with #GNUNET_MQ_PREF_CORKING_ALLOWED as it would be a contradiction. When this flags is set, the envelope may skip forward in the queue (depending on priority) and also TRANSPORT should attempt to pick a communicator with particularly low latency.

GNUNET_MQ_PREF_CORK_ALLOWED 

Flag to indicate that CORKing is acceptable.

This allows the receiver to delay transmission in hope of combining this message with other messages into a larger transmission with less per-message overhead.

GNUNET_MQ_PREF_GOODPUT 

Flag to indicate that high bandwidth is desired.

This flag indicates that the method chosen for transmission should focus on overall goodput. It rarely makes sense to combine this flag with GNUNET_MQ_PREF_LOW_LATENCY.

GNUNET_MQ_PREF_OUT_OF_ORDER 

Flag to indicate that out-of-order delivery is OK.

Definition at line 231 of file gnunet_mq_lib.h.

232 {
238 
243 
248 
253 
258 
272 
282 
290 
298 
303 };
@ GNUNET_MQ_PREF_OUT_OF_ORDER
Flag to indicate that out-of-order delivery is OK.
@ GNUNET_MQ_PRIO_URGENT
Urgent traffic (local peer, e.g.
@ GNUNET_MQ_PRIO_CRITICAL_CONTROL
Highest priority, control traffic (e.g.
@ GNUNET_MQ_PRIORITY_MASK
Bit mask to apply to extract the priority bits.
@ GNUNET_MQ_PRIO_BACKGROUND
Lowest priority, i.e.
@ GNUNET_MQ_PREF_CORK_ALLOWED
Flag to indicate that CORKing is acceptable.
@ GNUNET_MQ_PREF_UNRELIABLE
Flag to indicate that unreliable delivery is acceptable.
@ GNUNET_MQ_PREF_GOODPUT
Flag to indicate that high bandwidth is desired.
@ GNUNET_MQ_PREF_LOW_LATENCY
Flag to indicate that low latency is important.
@ GNUNET_MQ_PRIO_BEST_EFFORT
Best-effort traffic (e.g.

◆ GNUNET_MQ_PreferenceKind

Enum defining all known preference categories.

Deprecated:
will be replaced by enum GNUNET_MQ_PriorityPreference
Enumerator
GNUNET_MQ_PREFERENCE_NONE 

No preference was expressed.

GNUNET_MQ_PREFERENCE_BANDWIDTH 

The preferred transmission for this envelope focuses on maximizing bandwidth.

GNUNET_MQ_PREFERENCE_LATENCY 

The preferred transmission for this envelope foces on minimizing latency.

GNUNET_MQ_PREFERENCE_RELIABILITY 

The preferred transmission for this envelope foces on reliability.

Definition at line 1081 of file gnunet_mq_lib.h.

1082 {
1087 
1093 
1099 
1105 
1109 #define GNUNET_MQ_PREFERENCE_COUNT 4
1110 };
@ GNUNET_MQ_PREFERENCE_RELIABILITY
The preferred transmission for this envelope foces on reliability.
@ GNUNET_MQ_PREFERENCE_NONE
No preference was expressed.
@ GNUNET_MQ_PREFERENCE_LATENCY
The preferred transmission for this envelope foces on minimizing latency.
@ GNUNET_MQ_PREFERENCE_BANDWIDTH
The preferred transmission for this envelope focuses on maximizing bandwidth.

Function Documentation

◆ GNUNET_MQ_extract_nested_mh_()

const struct GNUNET_MessageHeader* GNUNET_MQ_extract_nested_mh_ ( const struct GNUNET_MessageHeader mh,
uint16_t  base_size 
)

Implementation of the #GNUNET_MQ_extract_nexted_mh macro.

Parameters
mhmessage header to extract nested message header from
base_sizesize of the message before the nested message's header appears
Returns
pointer to the nested message, does not copy the message OR NULL in case of a malformed message.

Definition at line 743 of file mq.c.

745 {
746  uint16_t whole_size;
747  uint16_t nested_size;
748  const struct GNUNET_MessageHeader *nested_msg;
749 
750  whole_size = ntohs (mh->size);
751  GNUNET_assert (whole_size >= base_size);
752  nested_size = whole_size - base_size;
753  if (0 == nested_size)
754  return NULL;
755  if (nested_size < sizeof(struct GNUNET_MessageHeader))
756  {
757  GNUNET_break_op (0);
758  return NULL;
759  }
760  nested_msg = (const struct GNUNET_MessageHeader *) ((char *) mh + base_size);
761  if (ntohs (nested_msg->size) != nested_size)
762  {
763  GNUNET_break_op (0);
764  return NULL;
765  }
766  return nested_msg;
767 }
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.

References GNUNET_assert, GNUNET_break_op, mh, and GNUNET_MessageHeader::size.

◆ GNUNET_MQ_env_get_msg()

const struct GNUNET_MessageHeader* GNUNET_MQ_env_get_msg ( const struct GNUNET_MQ_Envelope env)

Obtain message contained in envelope.

Parameters
envthe envelope
Returns
message contained in the envelope

Definition at line 882 of file mq.c.

883 {
884  return env->mh;
885 }
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
struct GNUNET_MessageHeader * mh
Actual allocated message header.
Definition: mq.c:51

References env, and GNUNET_MQ_Envelope::mh.

Referenced by do_send(), mqm_execute(), and route_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_env_next()

const struct GNUNET_MQ_Envelope* GNUNET_MQ_env_next ( const struct GNUNET_MQ_Envelope env)

Return next envelope in queue.

Parameters
enva queued envelope
Returns
next one, or NULL

Definition at line 889 of file mq.c.

890 {
891  return env->next;
892 }
struct GNUNET_MQ_Envelope * next
Messages are stored in a linked list.
Definition: mq.c:38

References env, and GNUNET_MQ_Envelope::next.

Referenced by route_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_msg_nested_mh_()

struct GNUNET_MQ_Envelope* GNUNET_MQ_msg_nested_mh_ ( struct GNUNET_MessageHeader **  mhp,
uint16_t  base_size,
uint16_t  type,
const struct GNUNET_MessageHeader nested_mh 
)

Implementation of the GNUNET_MQ_msg_nested_mh macro.

Parameters
mhppointer to the message header pointer that will be changed to allocate at the newly allocated space for the message.
base_sizesize of the data before the nested message
typetype of the message in the envelope
nested_mhthe message to append to the message after base_size

Definition at line 551 of file mq.c.

555 {
556  struct GNUNET_MQ_Envelope *mqm;
557  uint16_t size;
558 
559  if (NULL == nested_mh)
560  return GNUNET_MQ_msg_ (mhp,
561  base_size,
562  type);
563  size = base_size + ntohs (nested_mh->size);
564  /* check for uint16_t overflow */
565  if (size < base_size)
566  return NULL;
567  mqm = GNUNET_MQ_msg_ (mhp,
568  size,
569  type);
570  GNUNET_memcpy ((char *) mqm->mh + base_size,
571  nested_mh,
572  ntohs (nested_mh->size));
573  return mqm;
574 }
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
static unsigned int size
Size of the "table".
Definition: peer.c:67

References GNUNET_memcpy, GNUNET_MQ_msg_(), GNUNET_MQ_Envelope::mh, GNUNET_MessageHeader::size, size, and type.

Here is the call graph for this function:

◆ GNUNET_MQ_dll_insert_head()

void GNUNET_MQ_dll_insert_head ( struct GNUNET_MQ_Envelope **  env_head,
struct GNUNET_MQ_Envelope **  env_tail,
struct GNUNET_MQ_Envelope env 
)

Insert env into the envelope DLL starting at env_head Note that env must not be in any MQ while this function is used with DLLs defined outside of the MQ module.

This is just in case some application needs to also manage a FIFO of envelopes independent of MQ itself and wants to re-use the pointers internal to env. Use with caution.

Parameters
[in,out]env_headof envelope DLL
[in,out]env_tailtail of envelope DLL
[in,out]envelement to insert at the tail

Definition at line 927 of file mq.c.

930 {
931  GNUNET_CONTAINER_DLL_insert (*env_head,
932  *env_tail,
933  env);
934 }
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.

References env, and GNUNET_CONTAINER_DLL_insert.

Referenced by route_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_dll_insert_tail()

void GNUNET_MQ_dll_insert_tail ( struct GNUNET_MQ_Envelope **  env_head,
struct GNUNET_MQ_Envelope **  env_tail,
struct GNUNET_MQ_Envelope env 
)

Insert env into the envelope DLL starting at env_head Note that env must not be in any MQ while this function is used with DLLs defined outside of the MQ module.

This is just in case some application needs to also manage a FIFO of envelopes independent of MQ itself and wants to re-use the pointers internal to env. Use with caution.

Parameters
[in,out]env_headof envelope DLL
[in,out]env_tailtail of envelope DLL
[in,out]envelement to insert at the tail

Definition at line 938 of file mq.c.

941 {
943  *env_tail,
944  env);
945 }
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.

References env, and GNUNET_CONTAINER_DLL_insert_tail.

Referenced by route_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_dll_remove()

void GNUNET_MQ_dll_remove ( struct GNUNET_MQ_Envelope **  env_head,
struct GNUNET_MQ_Envelope **  env_tail,
struct GNUNET_MQ_Envelope env 
)

Remove env from the envelope DLL starting at env_head.

Note that env must not be in any MQ while this function is used with DLLs defined outside of the MQ module. This is just in case some application needs to also manage a FIFO of envelopes independent of MQ itself and wants to re-use the pointers internal to env. Use with caution.

Parameters
[in,out]env_headof envelope DLL
[in,out]env_tailtail of envelope DLL
[in,out]envelement to remove from the DLL

Definition at line 949 of file mq.c.

952 {
953  GNUNET_CONTAINER_DLL_remove (*env_head,
954  *env_tail,
955  env);
956 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.

References env, and GNUNET_CONTAINER_DLL_remove.

Referenced by dir_ready_cb(), and discard_buffer().

Here is the caller graph for this function:

◆ GNUNET_MQ_copy_handlers()

struct GNUNET_MQ_MessageHandler* GNUNET_MQ_copy_handlers ( const struct GNUNET_MQ_MessageHandler handlers)

Copy an array of handlers.

Useful if the array has been declared in local memory and needs to be persisted for future use.

Parameters
handlersArray of handlers to be copied.
Returns
A newly allocated array of handlers. Needs to be freed with GNUNET_free.

Definition at line 960 of file mq.c.

961 {
962  struct GNUNET_MQ_MessageHandler *copy;
963  unsigned int count;
964 
965  if (NULL == handlers)
966  return NULL;
968  copy = GNUNET_new_array (count + 1,
969  struct GNUNET_MQ_MessageHandler);
970  GNUNET_memcpy (copy,
971  handlers,
972  count * sizeof(struct GNUNET_MQ_MessageHandler));
973  return copy;
974 }
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
#define GNUNET_new_array(n, type)
Allocate a size n array with structs or unions of the given type.
unsigned int GNUNET_MQ_count_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Count the handlers in a handler array.
Definition: mq.c:1003

References GNUNET_memcpy, GNUNET_MQ_count_handlers(), GNUNET_new_array, and handlers.

Referenced by GNUNET_CADET_open_port(), GNUNET_CADET_TEST_ruN(), GNUNET_CORE_connect(), GNUNET_MQ_queue_for_callbacks(), and GNUNET_SERVICE_run_().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_copy_handlers2()

struct GNUNET_MQ_MessageHandler* GNUNET_MQ_copy_handlers2 ( const struct GNUNET_MQ_MessageHandler handlers,
GNUNET_MQ_MessageCallback  agpl_handler,
void *  agpl_cls 
)

Copy an array of handlers, appending AGPL handler.

Useful if the array has been declared in local memory and needs to be persisted for future use.

Parameters
handlersArray of handlers to be copied. Can be NULL (nothing done).
agpl_handlerfunction to call for AGPL handling
agpl_clsclosure for agpl_handler
Returns
A newly allocated array of handlers. Needs to be freed with GNUNET_free.

Definition at line 978 of file mq.c.

981 {
982  struct GNUNET_MQ_MessageHandler *copy;
983  unsigned int count;
984 
985  if (NULL == handlers)
986  return NULL;
988  copy = GNUNET_new_array (count + 2,
989  struct GNUNET_MQ_MessageHandler);
990  GNUNET_memcpy (copy,
991  handlers,
992  count * sizeof(struct GNUNET_MQ_MessageHandler));
993  copy[count].mv = NULL;
994  copy[count].cb = agpl_handler;
995  copy[count].cls = agpl_cls;
997  copy[count].expected_size = sizeof(struct GNUNET_MessageHeader);
998  return copy;
999 }
uint16_t expected_size
Expected size of messages of this type.
GNUNET_MQ_MessageCallback cb
Callback, called every time a new message of the specified type has been received.
void * cls
Closure for mv and cb.
GNUNET_MQ_MessageValidationCallback mv
Callback to validate a message of the specified type.
uint16_t type
Type of the message this handler covers, in host byte order.
#define GNUNET_MESSAGE_TYPE_REQUEST_AGPL
Message to request source code link.

References GNUNET_MQ_MessageHandler::cb, GNUNET_MQ_MessageHandler::cls, GNUNET_MQ_MessageHandler::expected_size, GNUNET_memcpy, GNUNET_MESSAGE_TYPE_REQUEST_AGPL, GNUNET_MQ_count_handlers(), GNUNET_new_array, handlers, GNUNET_MQ_MessageHandler::mv, and GNUNET_MQ_MessageHandler::type.

Referenced by GNUNET_CADET_open_port(), GNUNET_SERVICE_run_(), and GNUNET_SERVICE_start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_count_handlers()

unsigned int GNUNET_MQ_count_handlers ( const struct GNUNET_MQ_MessageHandler handlers)

Count the handlers in a handler array.

Parameters
handlersArray of handlers to be counted.
Returns
The number of handlers in the array.

Definition at line 1003 of file mq.c.

1004 {
1005  unsigned int i;
1006 
1007  if (NULL == handlers)
1008  return 0;
1009  for (i = 0; NULL != handlers[i].cb; i++)
1010  ;
1011  return i;
1012 }

References handlers.

Referenced by GNUNET_CORE_connect(), GNUNET_MQ_copy_handlers(), and GNUNET_MQ_copy_handlers2().

Here is the caller graph for this function:

◆ GNUNET_MQ_handle_message()

int GNUNET_MQ_handle_message ( const struct GNUNET_MQ_MessageHandler handlers,
const struct GNUNET_MessageHeader mh 
)

Call the message message handler that was registered for the type of the given message in the given handlers list.

This function is indented to be used for the implementation of message queues.

Parameters
handlersa set of handlers
mhmessage to dispatch
Returns
GNUNET_OK on success, GNUNET_NO if no handler matched, GNUNET_SYSERR if message was rejected by check function

Definition at line 186 of file mq.c.

206 {
207  bool handled = false;
208  uint16_t msize = ntohs (mh->size);
209  uint16_t mtype = ntohs (mh->type);
210 
212  "Received message of type %u and size %u\n",
213  mtype,
214  msize);
215  if (NULL == handlers)
216  goto done;
217  for (const struct GNUNET_MQ_MessageHandler *handler = handlers;
218  NULL != handler->cb;
219  handler++)
220  {
221  if (handler->type == mtype)
222  {
223  handled = true;
224  if ( (handler->expected_size > msize) ||
225  ( (handler->expected_size != msize) &&
226  (NULL == handler->mv) ) )
227  {
228  /* Too small, or not an exact size and
229  no 'mv' handler to check rest */
231  "Received malformed message of type %u\n",
232  (unsigned int) handler->type);
233  return GNUNET_SYSERR;
234  }
235  if ( (NULL == handler->mv) ||
236  (GNUNET_OK ==
237  handler->mv (handler->cls,
238  mh)) )
239  {
240  /* message well-formed, pass to handler */
241  handler->cb (handler->cls, mh);
242  }
243  else
244  {
245  /* Message rejected by check routine */
247  "Received malformed message of type %u\n",
248  (unsigned int) handler->type);
249  return GNUNET_SYSERR;
250  }
251  break;
252  }
253  }
254 done:
255  if (! handled)
256  {
258  "No handler for message of type %u and size %u\n",
259  mtype,
260  msize);
261  return GNUNET_NO;
262  }
263  return GNUNET_OK;
264 }
static void done()
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_SYSERR
Definition: gnunet_common.h:97
@ GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_INFO
#define LOG(kind,...)
Definition: mq.c:29

References GNUNET_break_op, GNUNET_MQ_ERROR_MALFORMED, GNUNET_MQ_handle_message(), GNUNET_MQ_inject_error(), GNUNET_SYSERR, GNUNET_MQ_Handle::handlers, mh, mq, and ret.

Referenced by demultiplex_with_cmc(), GDS_u_receive(), and GNUNET_MQ_handle_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_msg_()

struct GNUNET_MQ_Envelope* GNUNET_MQ_msg_ ( struct GNUNET_MessageHeader **  mhp,
uint16_t  size,
uint16_t  type 
)

Create a new envelope.

Parameters
mhpmessage header to store the allocated message header in, can be NULL
sizesize of the message to allocate
typetype of the message, will be set in the allocated message
Returns
the allocated MQ message

Definition at line 519 of file mq.c.

522 {
523  struct GNUNET_MQ_Envelope *ev;
524 
525  ev = GNUNET_malloc (size + sizeof(struct GNUNET_MQ_Envelope));
526  ev->mh = (struct GNUNET_MessageHeader *) &ev[1];
527  ev->mh->size = htons (size);
528  ev->mh->type = htons (type);
529  if (NULL != mhp)
530  *mhp = ev->mh;
531  return ev;
532 }
#define GNUNET_malloc(size)
Wrapper around malloc.
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.

References GNUNET_malloc, GNUNET_MQ_Envelope::mh, GNUNET_MessageHeader::size, size, GNUNET_MessageHeader::type, and type.

Referenced by GNUNET_MQ_msg_nested_mh_().

Here is the caller graph for this function:

◆ GNUNET_MQ_msg_copy()

struct GNUNET_MQ_Envelope* GNUNET_MQ_msg_copy ( const struct GNUNET_MessageHeader hdr)

Create a new envelope by copying an existing message.

Parameters
hdrheader of the message to copy
Returns
envelope containing hdr

Definition at line 536 of file mq.c.

537 {
538  struct GNUNET_MQ_Envelope *mqm;
539  uint16_t size = ntohs (hdr->size);
540 
541  mqm = GNUNET_malloc (sizeof(*mqm) + size);
542  mqm->mh = (struct GNUNET_MessageHeader *) &mqm[1];
543  GNUNET_memcpy (mqm->mh,
544  hdr,
545  size);
546  return mqm;
547 }

References GNUNET_malloc, GNUNET_memcpy, GNUNET_MQ_Envelope::mh, GNUNET_MessageHeader::size, and size.

Referenced by do_connect(), GNUNET_MQ_env_copy(), GNUNET_notification_context_broadcast(), GNUNET_PEERINFO_add_peer(), GNUNET_TRANSPORT_offer_hello(), GST_clients_broadcast_peer_notification(), GST_forwarded_operation_reply_relay(), handle_barrier_status(), handle_send_msg(), handle_start(), notify_client(), plugin_session_info_cb(), route_message(), schedule_next_hello(), send_key(), send_peer_information(), send_ping(), transmit_task_cb(), and unicast().

Here is the caller graph for this function:

◆ GNUNET_MQ_discard()

void GNUNET_MQ_discard ( struct GNUNET_MQ_Envelope mqm)

Discard the message queue message, free all allocated resources.

Must be called in the event that a message is created but should not actually be sent.

Parameters
mqmthe message to discard

Definition at line 284 of file mq.c.

285 {
286  GNUNET_assert (NULL == ev->parent_queue);
287  GNUNET_free (ev);
288 }
#define GNUNET_free(ptr)
Wrapper around free.

References GNUNET_assert, GNUNET_free, and GNUNET_MQ_Envelope::parent_queue.

Referenced by abort_all_requests(), broadcast_status(), cadet_mq_cancel_impl(), core_mq_cancel_impl(), destroy_channel(), discard_buffer(), disconnect_and_free_peer_entry(), free_ait(), free_channel_client(), free_it(), free_op(), free_qe(), free_queue_entry(), free_ze(), GCCH_handle_channel_plaintext_data(), GCP_request_mq_cancel(), GCP_send_ooo(), GCP_set_mq(), GCT_send_cancel(), GNUNET_ABD_request_cancel(), GNUNET_GNS_lookup_cancel(), GNUNET_MQ_destroy(), GSF_peer_disconnect_handler(), handle_dns_response(), handle_result(), make_queue_entry(), mqm_execute(), send_client_element(), send_to_channel(), and set_operation_destroy().

Here is the caller graph for this function:

◆ GNUNET_MQ_get_current_envelope()

struct GNUNET_MQ_Envelope* GNUNET_MQ_get_current_envelope ( struct GNUNET_MQ_Handle mq)

Function to obtain the current envelope from within GNUNET_MQ_SendImpl implementations.

Parameters
mqmessage queue to interrogate
Returns
the current envelope

Definition at line 816 of file mq.c.

817 {
818  return mq->current_envelope;
819 }
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
struct GNUNET_MQ_Envelope * current_envelope
Message that is currently scheduled to be sent.
Definition: mq.c:143

References GNUNET_MQ_Handle::current_envelope, and mq.

Referenced by cadet_mq_send_impl(), core_mq_send_impl(), and mq_send_impl().

Here is the caller graph for this function:

◆ GNUNET_MQ_env_copy()

struct GNUNET_MQ_Envelope* GNUNET_MQ_env_copy ( struct GNUNET_MQ_Envelope env)

Function to copy an envelope.

The envelope must not yet be in any queue or have any options or callbacks set.

Parameters
envenvelope to copy
Returns
copy of env

Definition at line 362 of file mq.c.

363 {
364  GNUNET_assert (NULL == env->next);
365  GNUNET_assert (NULL == env->parent_queue);
366  GNUNET_assert (NULL == env->sent_cb);
368  return GNUNET_MQ_msg_copy (env->mh);
369 }
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_copy(const struct GNUNET_MessageHeader *hdr)
Create a new envelope by copying an existing message.
Definition: mq.c:536
struct GNUNET_MQ_Handle * parent_queue
Queue the message is queued in, NULL if message is not queued.
Definition: mq.c:56
int have_custom_options
Did the application call GNUNET_MQ_env_set_options()?
Definition: mq.c:78
GNUNET_SCHEDULER_TaskCallback sent_cb
Called after the message was sent irrevocably.
Definition: mq.c:61

References env, GNUNET_assert, GNUNET_MQ_msg_copy(), GNUNET_NO, GNUNET_MQ_Envelope::have_custom_options, GNUNET_MQ_Envelope::mh, GNUNET_MQ_Envelope::next, GNUNET_MQ_Envelope::parent_queue, and GNUNET_MQ_Envelope::sent_cb.

Referenced by cadet_channel_end_cb(), and dns_pre_request_handler().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_get_last_envelope()

struct GNUNET_MQ_Envelope* GNUNET_MQ_get_last_envelope ( struct GNUNET_MQ_Handle mq)

Function to obtain the last envelope in the queue.

Parameters
mqmessage queue to interrogate
Returns
the last envelope in the queue

Definition at line 823 of file mq.c.

824 {
825  if (NULL != mq->envelope_tail)
826  return mq->envelope_tail;
827 
828  return mq->current_envelope;
829 }
struct GNUNET_MQ_Envelope * envelope_tail
Linked list of messages pending to be sent.
Definition: mq.c:136

References GNUNET_MQ_Handle::current_envelope, GNUNET_MQ_Handle::envelope_tail, and mq.

◆ GNUNET_MQ_env_set_options()

void GNUNET_MQ_env_set_options ( struct GNUNET_MQ_Envelope env,
enum GNUNET_MQ_PriorityPreferences  pp 
)

Set application-specific options for this envelope.

Overrides the options set for the queue with GNUNET_MQ_set_options() for this message only.

Parameters
envmessage to set options for
pppriority and preferences to set for env

Definition at line 833 of file mq.c.

835 {
836  env->priority = pp;
838 }
@ GNUNET_YES
enum GNUNET_MQ_PriorityPreferences priority
Flags that were set for this envelope by GNUNET_MQ_env_set_options().
Definition: mq.c:73

Referenced by adv_transmit(), client_request_complete_alice(), route_message(), send_to_channel(), and transmit_pending().

Here is the caller graph for this function:

◆ GNUNET_MQ_env_get_options()

enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_get_options ( struct GNUNET_MQ_Envelope env)

Get performance preferences set for this envelope.

Parameters
envmessage to set options for
Returns
priority and preferences to use

Definition at line 833 of file mq.c.

843 {
844  struct GNUNET_MQ_Handle *mq = env->parent_queue;
845 
847  return env->priority;
848  if (NULL == mq)
849  return 0;
850  return mq->priority;
851 }
Handle to a message queue.
Definition: mq.c:86
enum GNUNET_MQ_PriorityPreferences priority
Flags that were set for this queue by GNUNET_MQ_set_options().
Definition: mq.c:164

Referenced by cadet_mq_send_impl(), core_mq_send_impl(), mq_send_impl(), and route_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_env_combine_options()

enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_combine_options ( enum GNUNET_MQ_PriorityPreferences  p1,
enum GNUNET_MQ_PriorityPreferences  p2 
)

Combine performance preferences set for different envelopes that are being combined into one larger envelope.

Parameters
p1one set of preferences
p2second set of preferences
Returns
combined priority and preferences to use

Definition at line 833 of file mq.c.

857 {
859 
862  ret |=
864  ret |=
867  ret |=
869  return ret;
870 }
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
#define GNUNET_MAX(a, b)
GNUNET_MQ_PriorityPreferences
Per envelope preferences and priorities.

References env, GNUNET_YES, GNUNET_MQ_Envelope::have_custom_options, and GNUNET_MQ_Envelope::priority.

◆ GNUNET_MQ_unsent_head()

struct GNUNET_MQ_Envelope* GNUNET_MQ_unsent_head ( struct GNUNET_MQ_Handle mq)

Remove the first envelope that has not yet been sent from the message queue and return it.

Parameters
mqqueue to remove envelope from
Returns
NULL if queue is empty (or has no envelope that is not under transmission)

Definition at line 347 of file mq.c.

348 {
349  struct GNUNET_MQ_Envelope *env;
350 
351  env = mq->envelope_head;
353  mq->envelope_tail,
354  env);
355  mq->queue_length--;
356  env->parent_queue = NULL;
357  return env;
358 }
struct GNUNET_MQ_Envelope * envelope_head
Linked list of messages pending to be sent.
Definition: mq.c:131
unsigned int queue_length
Number of entries we have in the envelope-DLL.
Definition: mq.c:176

References env, GNUNET_MQ_Handle::envelope_head, GNUNET_MQ_Handle::envelope_tail, GNUNET_CONTAINER_DLL_remove, mq, GNUNET_MQ_Envelope::parent_queue, and GNUNET_MQ_Handle::queue_length.

Referenced by send_to_channel().

Here is the caller graph for this function:

◆ GNUNET_MQ_set_options()

void GNUNET_MQ_set_options ( struct GNUNET_MQ_Handle mq,
enum GNUNET_MQ_PriorityPreferences  pp 
)

Set application-specific options for this queue.

Parameters
mqmessage queue to set options for
pppriority and preferences to use by default

Definition at line 874 of file mq.c.

876 {
877  mq->priority = pp;
878 }

References mq, and GNUNET_MQ_Handle::priority.

Referenced by connect_notify(), and handle_core_connect().

Here is the caller graph for this function:

◆ GNUNET_MQ_get_length()

unsigned int GNUNET_MQ_get_length ( struct GNUNET_MQ_Handle mq)

Obtain the current length of the message queue.

Parameters
mqqueue to inspect
Returns
number of queued, non-transmitted messages

Definition at line 292 of file mq.c.

293 {
294  if (! mq->in_flight)
295  {
296  return mq->queue_length;
297  }
298  return mq->queue_length - 1;
299 }
bool in_flight
True if GNUNET_MQ_impl_send_in_flight() was called.
Definition: mq.c:181

References GNUNET_MQ_Handle::in_flight, mq, and GNUNET_MQ_Handle::queue_length.

Referenced by continue_writing(), GCP_send(), GCP_send_ooo(), GNUNET_notification_context_broadcast(), GNUNET_STATISTICS_destroy(), GNUNET_TRANSPORT_communicator_receive(), GSC_CLIENTS_deliver_message(), GSC_NEIGHBOURS_get_queue_length(), handle_p2p_get(), schedule_action(), send_to_channel(), transmit_pending(), and unicast().

Here is the caller graph for this function:

◆ GNUNET_MQ_send()

void GNUNET_MQ_send ( struct GNUNET_MQ_Handle mq,
struct GNUNET_MQ_Envelope ev 
)

Send a message with the given message queue.

May only be called once per message.

Parameters
mqmessage queue
evthe envelope with the message to send.

Definition at line 303 of file mq.c.

305 {
306  if (NULL == mq)
308  "mq is NUll when sending message of type %u\n",
309  (unsigned int) ntohs (ev->mh->type));
310  GNUNET_assert (NULL != mq);
311  GNUNET_assert (NULL == ev->parent_queue);
312 
313  mq->queue_length++;
314  if (mq->queue_length >= 10000000)
315  {
316  /* This would seem like a bug... */
318  "MQ with %u entries extended by message of type %u (FC broken?)\n",
319  (unsigned int) mq->queue_length,
320  (unsigned int) ntohs (ev->mh->type));
321  }
322  ev->parent_queue = mq;
323  /* is the implementation busy? queue it! */
324  if ((NULL != mq->current_envelope) || (NULL != mq->send_task))
325  {
327  mq->envelope_tail,
328  ev);
329  return;
330  }
331  GNUNET_assert (NULL == mq->envelope_head);
332  mq->current_envelope = ev;
333 
335  "sending message of type %u and size %u, queue empty (MQ: %p)\n",
336  ntohs (ev->mh->type),
337  ntohs (ev->mh->size),
338  mq);
339 
340  mq->send_impl (mq,
341  ev->mh,
342  mq->impl_state);
343 }
#define GNUNET_log(kind,...)
void * impl_state
Implementation-specific state.
Definition: mq.c:111
struct GNUNET_SCHEDULER_Task * send_task
Task to asynchronously run impl_send_continue().
Definition: mq.c:126
GNUNET_MQ_SendImpl send_impl
Actual implementation of message sending, called when a message is added.
Definition: mq.c:96

References GNUNET_MQ_Handle::current_envelope, GNUNET_MQ_Handle::envelope_head, GNUNET_MQ_Handle::envelope_tail, GNUNET_assert, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_log, GNUNET_MQ_Handle::impl_state, LOG, GNUNET_MQ_Envelope::mh, mq, GNUNET_MQ_Envelope::parent_queue, GNUNET_MQ_Handle::queue_length, GNUNET_MQ_Handle::send_impl, GNUNET_MQ_Handle::send_task, GNUNET_MessageHeader::size, and GNUNET_MessageHeader::type.

Referenced by add_get_request_to_pending(), add_to_tc(), addr_cb(), adv_transmit(), announce_reconnect(), attr_iter_cb(), attr_iter_finished(), attr_store_cont(), broadcast_status(), cadet_channel_end_cb(), cadet_mq_send_now(), cancel_stream(), change_handle_ego(), change_handle_name(), change_service(), change_srv_handle_member_id(), check_cadet_ring_message(), check_credential_iteration_start(), check_dht_local_hello_offer(), check_peer_online(), check_phone_ring(), check_ticket_iteration_start(), check_zone_to_name(), clean_up_channel(), client_request_complete_alice(), client_response_handler(), client_send_response(), conclude_autoconfig_request(), connect_cb(), consume_result_cb(), core_mq_send_impl(), core_send_connect_info(), cores_send_disconnect_info(), create_internal(), create_loc_uri(), cred_iter_finished(), cred_store_cont(), decode_and_send(), decrypt_conclude(), dispatch_buffer(), dns_pre_request_handler(), do_blacklist_check(), do_connect(), do_flood(), do_peer_connect(), do_plugin_connect(), do_send(), fail_intersection_operation(), fail_union_operation(), finish_cmc_handling_with_continue(), finish_handling_raw_message(), GAS_handle_address_destroyed(), GAS_handle_reservation_request(), GAS_scheduling_transmit_address_suggestion(), GCP_request_mq_cancel(), GCP_send_ooo(), get_action(), get_all_peers_iterator(), get_all_tunnels_iterator(), GNUNET_ARM_request_service_list(), GNUNET_ATS_address_destroy(), GNUNET_ATS_address_update(), GNUNET_ATS_performance_change_preference(), GNUNET_ATS_performance_give_feedback(), GNUNET_ATS_performance_list_addresses(), GNUNET_ATS_reserve_bandwidth(), GNUNET_CADET_channel_create(), GNUNET_CADET_channel_destroy(), GNUNET_CADET_close_port(), GNUNET_CADET_drop_message(), GNUNET_CADET_receive_done(), GNUNET_CONSENSUS_conclude(), GNUNET_CONSENSUS_create(), GNUNET_CONSENSUS_insert(), GNUNET_CONVERSATION_call_resume(), GNUNET_CONVERSATION_call_suspend(), GNUNET_CONVERSATION_caller_hang_up(), GNUNET_CONVERSATION_caller_pick_up(), GNUNET_CONVERSATION_caller_resume(), GNUNET_CONVERSATION_caller_suspend(), GNUNET_DATASTORE_disconnect(), GNUNET_DHT_get_stop(), GNUNET_DHT_hello_get(), GNUNET_DHT_hello_offer(), GNUNET_DHT_monitor_stop(), GNUNET_DHT_put(), GNUNET_DNS_request_answer(), GNUNET_DNS_request_drop(), GNUNET_DNS_request_forward(), GNUNET_FS_get_indexed_files(), GNUNET_FS_indexing_send_list(), GNUNET_IDENTITY_create(), GNUNET_IDENTITY_delete(), GNUNET_IDENTITY_ego_lookup(), GNUNET_IDENTITY_ego_lookup_by_suffix(), GNUNET_IDENTITY_rename(), GNUNET_MESSENGER_connect(), GNUNET_MESSENGER_disconnect(), GNUNET_MESSENGER_get_message(), GNUNET_MESSENGER_send_message(), GNUNET_MESSENGER_set_name(), GNUNET_MESSENGER_update(), GNUNET_MQ_send_copy(), GNUNET_NAMECACHE_block_cache(), GNUNET_NAMECACHE_lookup_block(), GNUNET_NAMESTORE_records_store2(), GNUNET_NAMESTORE_zone_iteration_start(), GNUNET_NAMESTORE_zone_iteration_start2(), GNUNET_NAMESTORE_zone_iteration_stop(), GNUNET_NAMESTORE_zone_iterator_next(), GNUNET_NAMESTORE_zone_monitor_next(), GNUNET_NAMESTORE_zone_to_name(), GNUNET_NAT_AUTO_autoconfig_start(), GNUNET_NAT_request_reversal(), GNUNET_NAT_stun_handle_packet(), GNUNET_notification_context_broadcast(), GNUNET_PEERINFO_add_peer(), GNUNET_PEERSTORE_iterate(), GNUNET_PEERSTORE_store(), GNUNET_PEERSTORE_watch(), GNUNET_PEERSTORE_watch_cancel(), GNUNET_RECLAIM_get_attributes_next(), GNUNET_RECLAIM_get_attributes_start(), GNUNET_RECLAIM_get_attributes_stop(), GNUNET_RECLAIM_get_credentials_next(), GNUNET_RECLAIM_get_credentials_start(), GNUNET_RECLAIM_get_credentials_stop(), GNUNET_RECLAIM_ticket_iteration_next(), GNUNET_RECLAIM_ticket_iteration_start(), GNUNET_RECLAIM_ticket_iteration_stop(), GNUNET_RECLAIM_ticket_revoke(), GNUNET_REVOCATION_query(), GNUNET_REVOCATION_revoke(), GNUNET_RPS_seed_ids(), GNUNET_RPS_stream_request(), GNUNET_RPS_sub_start(), GNUNET_RPS_sub_stop(), GNUNET_RPS_view_request(), GNUNET_RPS_view_request_cancel(), GNUNET_SCALARPRODUCT_accept_computation(), GNUNET_SCALARPRODUCT_start_computation(), GNUNET_SECRETSHARING_create_session(), GNUNET_SECRETSHARING_decrypt(), gnunet_send(), GNUNET_SET_add_element(), GNUNET_SET_commit(), GNUNET_SET_copy_lazy(), GNUNET_SET_iterate(), GNUNET_SET_operation_cancel(), GNUNET_SET_remove_element(), GNUNET_SETI_add_element(), GNUNET_SETI_commit(), GNUNET_SETI_create(), GNUNET_SETI_operation_cancel(), GNUNET_SETU_add_element(), GNUNET_SETU_commit(), GNUNET_SETU_create(), GNUNET_SETU_operation_cancel(), GNUNET_TESTBED_barrier_cancel(), GNUNET_TESTBED_barrier_init_(), GNUNET_TESTBED_barrier_wait(), GNUNET_TESTBED_controller_connect(), GNUNET_TESTBED_forward_operation_msg_(), GNUNET_TESTBED_queue_message_(), GNUNET_TRANSPORT_address_to_string(), GNUNET_TRANSPORT_application_suggest_cancel(), GNUNET_TRANSPORT_communicator_notify(), GNUNET_TRANSPORT_communicator_receive(), GNUNET_TRANSPORT_manipulation_set(), GNUNET_TRANSPORT_offer_hello(), GNUNET_TRANSPORT_TESTING_send(), GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue(), GNUNET_TRANSPORT_TESTING_transport_communicator_send(), GSC_CLIENTS_deliver_message(), GSC_CLIENTS_notify_client_about_neighbour(), GSC_CLIENTS_solicit_request(), GSC_KX_encrypt_and_transmit(), GSC_send_to_client(), GST_clients_broadcast_peer_notification(), GST_forwarded_operation_reply_relay(), GST_send_operation_fail_msg(), GST_send_operation_success_msg(), handle_add_host(), handle_backchannel_encapsulation(), handle_barrier_status(), handle_block_cache(), handle_cadet_audio_message(), handle_cadet_hangup_message(), handle_cadet_pickup_message(), handle_cadet_resume_message(), handle_cadet_ring_message(), handle_cadet_suspend_message(), handle_channel_created(), handle_client_accept(), handle_client_address_to_string(), handle_client_call_message(), handle_client_copy_lazy_prepare(), handle_client_evaluate(), handle_client_hangup_message(), handle_client_init(), handle_client_loc_sign(), handle_client_monitor_peers(), handle_client_pickup_message(), handle_client_resume_message(), handle_client_suspend_message(), handle_client_unindex(), handle_communicator_backchannel(), handle_create_queue(), handle_data(), handle_datastore_reply(), handle_disconnect(), handle_get(), handle_get_all(), handle_get_peers(), handle_gns_response(), handle_incoming_msg(), handle_info_tunnels(), handle_iter_element(), handle_list(), handle_lookup_block(), handle_lookup_block_it(), handle_lookup_by_suffix_message(), handle_lookup_message(), handle_notify(), handle_peer_create(), handle_peer_get_config(), handle_peer_start(), handle_peer_stop(), handle_ping(), handle_query(), handle_record_lookup(), handle_request(), handle_revoke_message(), handle_room_close(), handle_room_entry(), handle_room_open(), handle_search_result(), handle_send_msg(), handle_send_ready(), handle_show_path(), handle_slave_get_config(), handle_start(), handle_start_message(), handle_test(), handle_union_p2p_demand(), handle_union_p2p_full_done(), handle_union_p2p_offer(), handle_union_p2p_strata_estimator(), handle_zone_to_name(), hash_for_index_cb(), hash_for_index_val(), intersection_evaluate(), keygen_round2_conclude(), listen_connect(), maybe_finish(), monitor_sync(), mq_send_impl(), mqm_execute(), notify_change(), notify_client(), notify_clients_stun_change(), notify_monitor(), notify_srv_handle_message(), open_port_cb(), opstart_manage_service(), opstart_overlay_connect(), opstart_peer_create(), opstart_peer_destroy(), opstart_peer_reconfigure(), opstart_peer_start(), opstart_peer_stop(), opstart_shutdown_peers(), path_info_iterator(), peer_transmit(), plugin_session_info_cb(), prepare_client_end_notification(), process_dns_result(), process_queue(), process_requests(), put_action(), queue_send_msg(), read_stdio(), reconnect(), reconnect_arm(), reconnect_arm_monitor(), reconnect_phone(), record_iterator(), records_lookup(), response_action(), retry_entry(), return_agpl(), reversal_callback(), revoke_result_cb(), rewatch_it(), schedule_action(), schedule_next_hello(), schedule_transmit_search_request(), search_reconnect(), send_ack(), send_add_address(), send_add_address_message(), send_add_queue(), send_alices_cryptodata_message(), send_bloomfilter(), send_client_done(), send_client_done_and_destroy(), send_client_element(), send_client_removed_element(), send_client_reply(), send_client_status_msg(), send_close_room(), send_controller_link_response(), send_del_address(), send_del_queue(), send_delete_response(), send_echo(), send_element_count(), send_end_msg(), send_enter_room(), send_full_element_iterator(), send_full_set(), send_get(), send_ibf(), send_ic_request(), send_intermediate_response(), send_key(), send_lookup_response(), send_lookup_response_with_filter(), send_message(), send_missing_full_elements_iter(), send_monitor_start(), send_msg(), send_offers_iterator(), send_open_room(), send_overlay_connect_success_msg(), send_p2p_done(), send_packet_to_cadet_channel(), send_peer_information(), send_ping(), send_remaining_elements(), send_reply(), send_request(), send_request_to_client(), send_result_code(), send_simple_cb(), send_start_monitor(), send_store_response(), send_stream_peers(), send_ticket_result(), send_to_channel(), send_to_client_iter(), send_transaction_control_msg(), send_tunnel_envelope(), send_tx_response(), send_update_queue(), send_view(), signal_index_ok(), signal_result(), suggest_to_connect(), test_nat_punched(), transmit(), transmit_address_to_client(), transmit_bobs_cryptodata_message(), transmit_bobs_cryptodata_message_multipart(), transmit_call_audio(), transmit_client_response(), transmit_get(), transmit_item(), transmit_pending(), transmit_req_addr(), transmit_set(), transmit_status(), transmit_suggestion(), transmit_task_cb(), transmit_watch(), unicast(), unindex_finish(), union_accept(), union_evaluate(), watch_notifier_it(), and zone_iteration_done_client_continue().

◆ GNUNET_MQ_send_copy()

void GNUNET_MQ_send_copy ( struct GNUNET_MQ_Handle mq,
const struct GNUNET_MQ_Envelope ev 
)

Send a copy of a message with the given message queue.

Can be called repeatedly on the same envelope.

Parameters
mqmessage queue
evthe envelope with the message to send.

Definition at line 373 of file mq.c.

375 {
376  struct GNUNET_MQ_Envelope *env;
377  uint16_t msize;
378 
379  msize = ntohs (ev->mh->size);
380  env = GNUNET_malloc (sizeof(struct GNUNET_MQ_Envelope) + msize);
381  env->mh = (struct GNUNET_MessageHeader *) &env[1];
382  env->sent_cb = ev->sent_cb;
383  env->sent_cls = ev->sent_cls;
384  GNUNET_memcpy (&env[1], ev->mh, msize);
385  GNUNET_MQ_send (mq, env);
386 }
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:303
void * sent_cls
Closure for send_cb.
Definition: mq.c:66

References env, GNUNET_malloc, GNUNET_memcpy, GNUNET_MQ_send(), GNUNET_MQ_Envelope::mh, mq, GNUNET_MQ_Envelope::sent_cb, GNUNET_MQ_Envelope::sent_cls, and GNUNET_MessageHeader::size.

Referenced by GNUNET_ABD_collect(), GNUNET_ABD_verify(), GNUNET_GNS_lookup_limited(), GNUNET_RECLAIM_attribute_delete(), GNUNET_RECLAIM_attribute_store(), GNUNET_RECLAIM_credential_delete(), GNUNET_RECLAIM_credential_store(), GNUNET_RECLAIM_ticket_consume(), GNUNET_RECLAIM_ticket_issue(), and reconnect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_send_cancel()

void GNUNET_MQ_send_cancel ( struct GNUNET_MQ_Envelope ev)

Cancel sending the message.

Message must have been sent with GNUNET_MQ_send before. May not be called after the notify sent callback has been called

Parameters
evqueued envelope to cancel

Definition at line 771 of file mq.c.

772 {
773  struct GNUNET_MQ_Handle *mq = ev->parent_queue;
774 
775  GNUNET_assert (NULL != mq);
776  GNUNET_assert (NULL != mq->cancel_impl);
778  mq->queue_length--;
779  if (mq->current_envelope == ev)
780  {
781  /* complex case, we already started with transmitting
782  the message using the callbacks. */
784  mq->cancel_impl (mq,
785  mq->impl_state);
786  /* continue sending the next message, if any */
788  if (NULL != mq->current_envelope)
789  {
791  mq->envelope_tail,
794  "sending canceled message of type %u queue\n",
795  ntohs (ev->mh->type));
796  mq->send_impl (mq,
798  mq->impl_state);
799  }
800  }
801  else
802  {
803  /* simple case, message is still waiting in the queue */
805  mq->envelope_tail,
806  ev);
807  }
808  ev->parent_queue = NULL;
809  ev->mh = NULL;
810  /* also frees ev */
811  GNUNET_free (ev);
812 }
GNUNET_MQ_CancelImpl cancel_impl
Implementation-dependent send cancel function.
Definition: mq.c:106

References GNUNET_MQ_Handle::cancel_impl, GNUNET_MQ_Handle::current_envelope, GNUNET_MQ_Handle::envelope_head, GNUNET_MQ_Handle::envelope_tail, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_MQ_Handle::impl_state, GNUNET_MQ_Handle::in_flight, LOG, GNUNET_MQ_Envelope::mh, mq, GNUNET_MQ_Envelope::parent_queue, GNUNET_MQ_Handle::queue_length, GNUNET_MQ_Handle::send_impl, and GNUNET_MessageHeader::type.

Referenced by check_cadet_ring_message(), GSF_push_stop_(), mq_cancel_impl(), neighbour_delete(), and shutdown_task().

Here is the caller graph for this function:

◆ GNUNET_MQ_assoc_add()

uint32_t GNUNET_MQ_assoc_add ( struct GNUNET_MQ_Handle mq,
void *  assoc_data 
)

Associate the assoc_data in mq with a unique request id.

Parameters
mqmessage queue, id will be unique for the queue
assoc_datato associate

Definition at line 578 of file mq.c.

580 {
581  uint32_t id;
582 
583  if (NULL == mq->assoc_map)
584  {
586  mq->assoc_id = 1;
587  }
588  id = mq->assoc_id++;
591  mq->assoc_map,
592  id,
593  assoc_data,
595  return id;
596 }
static struct GNUNET_IDENTITY_Handle * id
Handle to identity service.
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap32_put(struct GNUNET_CONTAINER_MultiHashMap32 *map, uint32_t key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
struct GNUNET_CONTAINER_MultiHashMap32 * GNUNET_CONTAINER_multihashmap32_create(unsigned int len)
Create a 32-bit key multi hash map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY
There must only be one value per key; storing a value should fail if a value under the same key alrea...
uint32_t assoc_id
Next id that should be used for the assoc_map, initialized lazily to a random value together with ass...
Definition: mq.c:171
struct GNUNET_CONTAINER_MultiHashMap32 * assoc_map
Map of associations, lazily allocated.
Definition: mq.c:148

References GNUNET_MQ_Handle::assoc_id, GNUNET_MQ_Handle::assoc_map, GNUNET_assert, GNUNET_CONTAINER_multihashmap32_create(), GNUNET_CONTAINER_multihashmap32_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_OK, id, and mq.

Referenced by GNUNET_SET_commit(), GNUNET_SETI_commit(), and GNUNET_SETU_commit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_assoc_get()

void* GNUNET_MQ_assoc_get ( struct GNUNET_MQ_Handle mq,
uint32_t  request_id 
)

Get the data associated with a request_id in a queue.

Parameters
mqthe message queue with the association
request_idthe request id we are interested in
Returns
the associated data

Definition at line 607 of file mq.c.

609 {
610  if (NULL == mq->assoc_map)
611  return NULL;
613  request_id);
614 }
void * GNUNET_CONTAINER_multihashmap32_get(const struct GNUNET_CONTAINER_MultiHashMap32 *map, uint32_t key)
Given a key find a value in the map matching the key.

References GNUNET_MQ_Handle::assoc_map, GNUNET_CONTAINER_multihashmap32_get(), and mq.

Referenced by handle_result().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_assoc_remove()

void* GNUNET_MQ_assoc_remove ( struct GNUNET_MQ_Handle mq,
uint32_t  request_id 
)

Remove the association for a request_id.

Parameters
mqthe message queue with the association
request_idthe request id we want to remove
Returns
the associated data

Definition at line 625 of file mq.c.

627 {
628  void *val;
629 
630  if (NULL == mq->assoc_map)
631  return NULL;
633  request_id);
635  request_id);
636  return val;
637 }
int GNUNET_CONTAINER_multihashmap32_remove_all(struct GNUNET_CONTAINER_MultiHashMap32 *map, uint32_t key)
Remove all entries for the given key from the map.

References GNUNET_MQ_Handle::assoc_map, GNUNET_CONTAINER_multihashmap32_get(), GNUNET_CONTAINER_multihashmap32_remove_all(), and mq.

Referenced by handle_result(), and set_operation_destroy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_queue_for_callbacks()

struct GNUNET_MQ_Handle* GNUNET_MQ_queue_for_callbacks ( GNUNET_MQ_SendImpl  send,
GNUNET_MQ_DestroyImpl  destroy,
GNUNET_MQ_CancelImpl  cancel,
void *  impl_state,
const struct GNUNET_MQ_MessageHandler handlers,
GNUNET_MQ_ErrorHandler  error_handler,
void *  cls 
)

Create a message queue for the specified handlers.

Parameters
sendfunction the implements sending messages
destroyfunction that implements destroying the queue
cancelfunction that implements canceling a message
impl_statefor the queue, passed to send, destroy and cancel
handlersarray of message handlers
error_handlerhandler for read and write errors
clsclosure for message handlers and error handler
Returns
a new message queue

Definition at line 468 of file mq.c.

475 {
476  struct GNUNET_MQ_Handle *mq;
477 
478  mq = GNUNET_new (struct GNUNET_MQ_Handle);
479  mq->send_impl = send;
481  mq->cancel_impl = cancel;
486 
487  return mq;
488 }
static void error_handler(void *cls, enum GNUNET_MQ_Error error)
We encountered an error handling the MQ to the ATS service.
static void destroy(void *cls)
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_MQ_MessageHandler * GNUNET_MQ_copy_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Copy an array of handlers.
Definition: mq.c:960
GNUNET_MQ_DestroyImpl destroy_impl
Implementation-dependent queue destruction function.
Definition: mq.c:101
GNUNET_MQ_ErrorHandler error_handler
Callback will be called when an error occurs.
Definition: mq.c:116
struct GNUNET_MQ_MessageHandler * handlers
Handlers array, or NULL if the queue should not receive messages.
Definition: mq.c:90
void * error_handler_cls
Closure for the error handler.
Definition: mq.c:121

References GNUNET_MQ_Handle::cancel_impl, destroy(), GNUNET_MQ_Handle::destroy_impl, error_handler(), GNUNET_MQ_Handle::error_handler, GNUNET_MQ_Handle::error_handler_cls, GNUNET_MQ_copy_handlers(), GNUNET_new, handlers, GNUNET_MQ_Handle::handlers, GNUNET_MQ_Handle::impl_state, mq, and GNUNET_MQ_Handle::send_impl.

Referenced by boot_queue(), connect_peer(), GCT_create_tunnel(), GNUNET_CADET_channel_create(), GNUNET_CLIENT_connect(), handle_channel_created(), handle_connect(), setup_queue(), setup_receiver_mq(), and start_client().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_set_handlers_closure()

void GNUNET_MQ_set_handlers_closure ( struct GNUNET_MQ_Handle mq,
void *  handlers_cls 
)

Change the closure argument in all of the handlers of the mq.

Parameters
mqto modify
handlers_clsnew closure to use

Definition at line 492 of file mq.c.

494 {
495  if (NULL == mq->handlers)
496  return;
497  for (unsigned int i = 0; NULL != mq->handlers[i].cb; i++)
498  mq->handlers[i].cls = handlers_cls;
499 }

References GNUNET_MQ_MessageHandler::cb, GNUNET_MQ_MessageHandler::cls, GNUNET_MQ_Handle::handlers, and mq.

Referenced by connect_peer(), GNUNET_CADET_channel_create(), handle_channel_created(), handle_connect(), and start_client().

Here is the caller graph for this function:

◆ GNUNET_MQ_notify_sent()

void GNUNET_MQ_notify_sent ( struct GNUNET_MQ_Envelope ev,
GNUNET_SCHEDULER_TaskCallback  cb,
void *  cb_cls 
)

Call a callback once the envelope has been sent, that is, sending it can not be canceled anymore.

There can be only one notify sent callback per envelope.

Parameters
evmessage to call the notify callback for
cbthe notify callback
cb_clsclosure for the callback

Definition at line 641 of file mq.c.

644 {
645  /* allow setting *OR* clearing callback */
646  GNUNET_assert ((NULL == ev->sent_cb) || (NULL == cb));
647  ev->sent_cb = cb;
648  ev->sent_cls = cb_cls;
649 }

References GNUNET_assert, GNUNET_MQ_Envelope::sent_cb, and GNUNET_MQ_Envelope::sent_cls.

Referenced by check_cadet_ring_message(), check_peer_online(), dispatch_buffer(), do_send(), finish_handling_raw_message(), GCP_request_mq_cancel(), GCP_send(), GCP_send_ooo(), GNUNET_CONSENSUS_insert(), GNUNET_DATASTORE_disconnect(), GNUNET_DHT_hello_offer(), GNUNET_DHT_put(), GNUNET_DHT_put_cancel(), GNUNET_PEERINFO_add_peer(), GNUNET_PEERSTORE_store(), gnunet_send(), GNUNET_SET_add_element(), GNUNET_SET_remove_element(), GNUNET_SETI_add_element(), GNUNET_SETU_add_element(), GNUNET_TRANSPORT_offer_hello(), GNUNET_TRANSPORT_TESTING_send(), GNUNET_TRANSPORT_TESTING_transport_communicator_send(), handle_client_hangup_message(), handle_datastore_reply(), handle_send_msg(), mq_send_impl(), read_stdio(), reconnect(), schedule_action(), schedule_peer_transmission(), send_message(), send_msg(), send_p2p_done(), send_remaining_elements(), send_tunnel_envelope(), transmit_bobs_cryptodata_message(), transmit_bobs_cryptodata_message_multipart(), transmit_content(), transmit_get(), transmit_pending(), transmit_set(), and transmit_watch().

Here is the caller graph for this function:

◆ GNUNET_MQ_destroy()

void GNUNET_MQ_destroy ( struct GNUNET_MQ_Handle mq)

Destroy the message queue.

Parameters
mqmessage queue to destroy

Definition at line 686 of file mq.c.

687 {
689 
690  if (NULL != mq->destroy_impl)
691  {
693  }
694  if (NULL != mq->send_task)
695  {
697  mq->send_task = NULL;
698  }
699  while (NULL != mq->envelope_head)
700  {
701  struct GNUNET_MQ_Envelope *ev;
702 
703  ev = mq->envelope_head;
704  ev->parent_queue = NULL;
707  mq->queue_length--;
709  "MQ destroy drops message of type %u\n",
710  ntohs (ev->mh->type));
711  GNUNET_MQ_discard (ev);
712  }
713  if (NULL != mq->current_envelope)
714  {
715  /* we can only discard envelopes that
716  * are not queued! */
719  "MQ destroy drops current message of type %u\n",
720  ntohs (mq->current_envelope->mh->type));
722  mq->current_envelope = NULL;
724  mq->queue_length--;
725  }
726  GNUNET_assert (0 == mq->queue_length);
727  while (NULL != (dnh = mq->dnh_head))
728  {
729  dnh->cb (dnh->cb_cls);
731  }
732  if (NULL != mq->assoc_map)
733  {
735  mq->assoc_map = NULL;
736  }
738  GNUNET_free (mq);
739 }
void GNUNET_CONTAINER_multihashmap32_destroy(struct GNUNET_CONTAINER_MultiHashMap32 *map)
Destroy a 32-bit key hash map.
void GNUNET_MQ_discard(struct GNUNET_MQ_Envelope *ev)
Discard the message queue message, free all allocated resources.
Definition: mq.c:284
void GNUNET_MQ_destroy_notify_cancel(struct GNUNET_MQ_DestroyNotificationHandle *dnh)
Cancel registration from GNUNET_MQ_destroy_notify().
Definition: mq.c:914
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:943
Handle we return for callbacks registered to be notified when GNUNET_MQ_destroy() is called on a queu...
Definition: mq.c:657
GNUNET_SCHEDULER_TaskCallback cb
Function to call.
Definition: mq.c:676
void * cb_cls
Closure for cb.
Definition: mq.c:681
struct GNUNET_MQ_DestroyNotificationHandle * dnh_head
Functions to call on queue destruction; kept in a DLL.
Definition: mq.c:153

References GNUNET_MQ_Handle::assoc_map, GNUNET_MQ_DestroyNotificationHandle::cb, GNUNET_MQ_DestroyNotificationHandle::cb_cls, GNUNET_MQ_Handle::current_envelope, GNUNET_MQ_Handle::destroy_impl, GNUNET_MQ_Handle::dnh_head, GNUNET_MQ_Handle::envelope_head, GNUNET_MQ_Handle::envelope_tail, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multihashmap32_destroy(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_MQ_destroy_notify_cancel(), GNUNET_MQ_discard(), GNUNET_SCHEDULER_cancel(), GNUNET_MQ_Handle::handlers, GNUNET_MQ_Handle::impl_state, LOG, GNUNET_MQ_Envelope::mh, mq, GNUNET_MQ_Envelope::parent_queue, GNUNET_MQ_Handle::queue_length, GNUNET_MQ_Handle::send_task, and GNUNET_MessageHeader::type.

Referenced by announce_mq_error_handler(), callback_mq_error(), check_key_type(), create_loc_uri(), deactivate_fs_download(), destroy_channel(), destroy_handle(), destroy_tunnel(), disconnect(), disconnect_and_free_peer_entry(), disconnect_and_schedule_reconnect(), do_disconnect(), do_reconnect(), download_mq_error_handler(), error_handler(), fail_call(), final_disconnect(), finish_client_drop(), force_reconnect(), GNUNET_ABD_disconnect(), GNUNET_ARM_disconnect(), GNUNET_ARM_monitor_stop(), GNUNET_ATS_connectivity_done(), GNUNET_ATS_performance_done(), GNUNET_ATS_scheduling_done(), GNUNET_CADET_disconnect(), GNUNET_CADET_get_channel_cancel(), GNUNET_CADET_get_path_cancel(), GNUNET_CADET_list_peers_cancel(), GNUNET_CADET_list_tunnels_cancel(), GNUNET_CONSENSUS_destroy(), GNUNET_CONVERSATION_call_stop(), GNUNET_CONVERSATION_phone_destroy(), GNUNET_CORE_disconnect(), GNUNET_CORE_monitor_stop(), GNUNET_DATASTORE_disconnect(), GNUNET_DHT_disconnect(), GNUNET_DNS_disconnect(), GNUNET_FS_get_indexed_files_cancel(), GNUNET_FS_search_pause(), GNUNET_FS_search_signal_suspend_(), GNUNET_FS_search_stop(), GNUNET_FS_unindex_signal_suspend_(), GNUNET_FS_unindex_stop(), GNUNET_GNS_disconnect(), GNUNET_IDENTITY_ego_lookup_by_suffix_cancel(), GNUNET_IDENTITY_ego_lookup_cancel(), GNUNET_NAMECACHE_disconnect(), GNUNET_NAMESTORE_disconnect(), GNUNET_NAMESTORE_zone_monitor_stop(), GNUNET_NAT_AUTO_autoconfig_cancel(), GNUNET_NAT_AUTO_test_stop(), GNUNET_NAT_autoconfig_cancel(), GNUNET_NAT_test_stop(), GNUNET_NAT_unregister(), GNUNET_NSE_disconnect(), GNUNET_PEERINFO_disconnect(), GNUNET_PEERINFO_notify_cancel(), GNUNET_RECLAIM_disconnect(), GNUNET_REGEX_announce_cancel(), GNUNET_REGEX_search_cancel(), GNUNET_RESOLVER_disconnect(), GNUNET_REVOCATION_query_cancel(), GNUNET_REVOCATION_revoke_cancel(), GNUNET_RPS_disconnect(), GNUNET_SCALARPRODUCT_cancel(), GNUNET_SECRETSHARING_decrypt_cancel(), GNUNET_SECRETSHARING_session_destroy(), GNUNET_SET_destroy(), GNUNET_SET_listen_cancel(), GNUNET_SETI_destroy(), GNUNET_SETI_listen_cancel(), GNUNET_SETU_destroy(), GNUNET_SETU_listen_cancel(), GNUNET_TESTBED_barrier_wait_cancel(), GNUNET_TESTBED_controller_disconnect(), GNUNET_TESTBED_LOGGER_disconnect(), GNUNET_TRANSPORT_address_to_string_cancel(), GNUNET_TRANSPORT_application_done(), GNUNET_TRANSPORT_blacklist_cancel(), GNUNET_TRANSPORT_communicator_mq_del(), GNUNET_TRANSPORT_hello_get_cancel(), GNUNET_TRANSPORT_monitor_peers_cancel(), GNUNET_TRANSPORT_monitor_plugins_cancel(), GNUNET_TRANSPORT_offer_hello_cancel(), GNUNET_VPN_disconnect(), handle_client_listener_error(), handle_conclude_done(), handle_index_start_failed(), handle_index_start_ok(), handle_mq_error(), handle_response(), handle_unindex_response(), index_mq_error_handler(), loc_mq_error_handler(), mq_error_handler(), neighbour_delete(), process_result_with_request(), publish_cleanup(), queue_destroy(), reconnect(), reconnect_arm_later(), reconnect_arm_monitor_later(), reconnect_later(), reconnect_peer_ctx(), reconnect_phone(), reconnect_plugin_ctx(), reschedule_connect(), search_mq_error_handler(), try_reconnect(), and unindex_mq_error_handler().

Here is the call graph for this function:

◆ GNUNET_MQ_destroy_notify()

struct GNUNET_MQ_DestroyNotificationHandle* GNUNET_MQ_destroy_notify ( struct GNUNET_MQ_Handle mq,
GNUNET_SCHEDULER_TaskCallback  cb,
void *  cb_cls 
)

Register function to be called whenever mq is being destroyed.

Parameters
mqmessage queue to watch
cbfunction to call on mq destruction
cb_clsclosure for cb
Returns
handle for GNUNET_MQ_destroy_notify_cancel().

Definition at line 896 of file mq.c.

899 {
901 
903  dnh->mq = mq;
904  dnh->cb = cb;
905  dnh->cb_cls = cb_cls;
907  mq->dnh_tail,
908  dnh);
909  return dnh;
910 }
struct GNUNET_MQ_Handle * mq
Queue to notify about.
Definition: mq.c:671
struct GNUNET_MQ_DestroyNotificationHandle * dnh_tail
Functions to call on queue destruction; kept in a DLL.
Definition: mq.c:158

References GNUNET_MQ_DestroyNotificationHandle::cb, GNUNET_MQ_DestroyNotificationHandle::cb_cls, GNUNET_MQ_Handle::dnh_head, GNUNET_MQ_Handle::dnh_tail, GNUNET_CONTAINER_DLL_insert, GNUNET_new, mq, and GNUNET_MQ_DestroyNotificationHandle::mq.

Referenced by GNUNET_notification_context_add().

Here is the caller graph for this function:

◆ GNUNET_MQ_destroy_notify_cancel()

void GNUNET_MQ_destroy_notify_cancel ( struct GNUNET_MQ_DestroyNotificationHandle dnh)

Cancel registration from GNUNET_MQ_destroy_notify().

Parameters
dnhhandle for registration to cancel

Definition at line 914 of file mq.c.

916 {
917  struct GNUNET_MQ_Handle *mq = dnh->mq;
918 
920  mq->dnh_tail,
921  dnh);
922  GNUNET_free (dnh);
923 }

References GNUNET_MQ_Handle::dnh_head, GNUNET_MQ_Handle::dnh_tail, GNUNET_CONTAINER_DLL_remove, GNUNET_free, mq, and GNUNET_MQ_DestroyNotificationHandle::mq.

Referenced by GNUNET_MQ_destroy(), and GNUNET_notification_context_destroy().

Here is the caller graph for this function:

◆ GNUNET_MQ_inject_message()

void GNUNET_MQ_inject_message ( struct GNUNET_MQ_Handle mq,
const struct GNUNET_MessageHeader mh 
)

Call the message message handler that was registered for the type of the given message in the given message queue.

This function is indented to be used for the implementation of message queues.

Parameters
mqmessage queue with the handlers
mhmessage to dispatch

Definition at line 186 of file mq.c.

188 {
190 
192  mh);
193  if (GNUNET_SYSERR == ret)
194  {
195  GNUNET_break_op (0);
198  return;
199  }
200 }
GNUNET_GenericReturnValue
Named constants for return values.
Definition: gnunet_common.h:96
void GNUNET_MQ_inject_error(struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_Error error)
Call the error handler of a message queue with the given error code.
Definition: mq.c:268
enum GNUNET_GenericReturnValue GNUNET_MQ_handle_message(const struct GNUNET_MQ_MessageHandler *handlers, const struct GNUNET_MessageHeader *mh)
Call the message message handler that was registered for the type of the given message in the given h...
Definition: mq.c:204

Referenced by handle_decrypted(), handle_local_data(), handle_notify_inbound(), handle_recv(), and service_client_mst_cb().

Here is the caller graph for this function:

◆ GNUNET_MQ_inject_error()

void GNUNET_MQ_inject_error ( struct GNUNET_MQ_Handle mq,
enum GNUNET_MQ_Error  error 
)

Call the error handler of a message queue with the given error code.

If there is no error handler, log a warning.

This function is intended to be used for the implementation of message queues.

Parameters
mqmessage queue
errorthe error type

Definition at line 268 of file mq.c.

270 {
271  if (NULL == mq->error_handler)
272  {
274  "Got error %d, but no handler installed\n",
275  (int) error);
276  return;
277  }
279  error);
280 }
@ GNUNET_ERROR_TYPE_WARNING

References GNUNET_MQ_Handle::error_handler, GNUNET_MQ_Handle::error_handler_cls, GNUNET_ERROR_TYPE_WARNING, LOG, and mq.

Referenced by do_send(), GNUNET_MQ_handle_message(), receive_ready(), and recv_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_impl_send_continue()

void GNUNET_MQ_impl_send_continue ( struct GNUNET_MQ_Handle mq)

Call the send implementation for the next queued message, if any.

Calls the send notification for the current message unless GNUNET_MQ_impl_send_in_flight was called for this envelope.

Only useful for implementing message queues, results in undefined behavior if not used carefully.

Parameters
mqmessage queue to send the next message with

Definition at line 424 of file mq.c.

425 {
426  struct GNUNET_MQ_Envelope *current_envelope;
428 
430  mq->queue_length--;
431  mq->in_flight = false;
432  current_envelope = mq->current_envelope;
433  current_envelope->parent_queue = NULL;
434  mq->current_envelope = NULL;
435  GNUNET_assert (NULL == mq->send_task);
437  if (NULL != (cb = current_envelope->sent_cb))
438  {
439  current_envelope->sent_cb = NULL;
440  cb (current_envelope->sent_cls);
441  }
442  GNUNET_free (current_envelope);
443 }
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1267
void(* GNUNET_SCHEDULER_TaskCallback)(void *cls)
Signature of the main function of a task.
static void impl_send_continue(void *cls)
Task run to call the send implementation for the next queued message, if any.
Definition: mq.c:397

References GNUNET_MQ_Handle::current_envelope, GNUNET_assert, GNUNET_free, GNUNET_SCHEDULER_add_now(), impl_send_continue(), GNUNET_MQ_Handle::in_flight, mq, GNUNET_MQ_Envelope::parent_queue, GNUNET_MQ_Handle::queue_length, GNUNET_MQ_Handle::send_task, GNUNET_MQ_Envelope::sent_cb, and GNUNET_MQ_Envelope::sent_cls.

Referenced by cadet_mq_send_impl(), cadet_mq_send_now(), core_mq_send_impl(), do_send(), handle_send_ready(), mq_send_d(), mq_send_impl(), mq_send_kx(), notify_send_done(), notify_send_done_fin(), queue_write(), recv_message(), and select_write_cb().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_MQ_impl_send_in_flight()

void GNUNET_MQ_impl_send_in_flight ( struct GNUNET_MQ_Handle mq)

Call the send notification for the current message, but do not try to send the next message until #gnunet_mq_impl_send_continue is called.

Only useful for implementing message queues, results in undefined behavior if not used carefully.

Parameters
mqmessage queue to send the next message with

Definition at line 447 of file mq.c.

448 {
449  struct GNUNET_MQ_Envelope *current_envelope;
451 
452  mq->in_flight = true;
453  /* call is only valid if we're actually currently sending
454  * a message */
455  current_envelope = mq->current_envelope;
456  GNUNET_assert (NULL != current_envelope);
457  /* can't call cancel from now on anymore */
458  current_envelope->parent_queue = NULL;
459  if (NULL != (cb = current_envelope->sent_cb))
460  {
461  current_envelope->sent_cb = NULL;
462  cb (current_envelope->sent_cls);
463  }
464 }

References GNUNET_MQ_Handle::current_envelope, GNUNET_assert, GNUNET_MQ_Handle::in_flight, mq, GNUNET_MQ_Envelope::parent_queue, GNUNET_MQ_Envelope::sent_cb, and GNUNET_MQ_Envelope::sent_cls.

Referenced by do_send(), notify_send_done(), and recv_message().

Here is the caller graph for this function:

◆ GNUNET_MQ_impl_state()

void* GNUNET_MQ_impl_state ( struct GNUNET_MQ_Handle mq)

Get the implementation state associated with the message queue.

While the GNUNET_MQ_Impl* callbacks receive the implementation state, continuations that are scheduled by the implementation function often only have one closure argument, with this function it is possible to get at the implementation state when only passing the struct GNUNET_MQ_Handle as closure.

Parameters
mqmessage queue with the current message
Returns
message to send, never NULL

Definition at line 512 of file mq.c.

513 {
514  return mq->impl_state;
515 }

References GNUNET_MQ_Handle::impl_state, and mq.

◆ GNUNET_MQ_impl_current()

const struct GNUNET_MessageHeader* GNUNET_MQ_impl_current ( struct GNUNET_MQ_Handle mq)

Get the message that should currently be sent.

Fails if there is no current message. Only useful for implementing message queues, results in undefined behavior if not used carefully.

Parameters
mqmessage queue with the current message
Returns
message to send, never NULL

Definition at line 503 of file mq.c.

504 {
505  GNUNET_assert (NULL != mq->current_envelope);
506  GNUNET_assert (NULL != mq->current_envelope->mh);
507  return mq->current_envelope->mh;
508 }

References GNUNET_MQ_Handle::current_envelope, GNUNET_assert, GNUNET_MQ_Envelope::mh, and mq.

◆ GNUNET_MQ_preference_to_string()

const char* GNUNET_MQ_preference_to_string ( enum GNUNET_MQ_PreferenceKind  type)

Convert an enum GNUNET_MQ_PreferenceType to a string.

Parameters
typethe preference type
Returns
a string or NULL if invalid
Deprecated:
will be replaced by enum GNUNET_MQ_PriorityPreference

Definition at line 1016 of file mq.c.

1017 {
1018  switch (type)
1019  {
1021  return "NONE";
1023  return "BANDWIDTH";
1025  return "LATENCY";
1027  return "RELIABILITY";
1028  }
1029  return NULL;
1030 }

References GNUNET_MQ_PREFERENCE_BANDWIDTH, GNUNET_MQ_PREFERENCE_LATENCY, GNUNET_MQ_PREFERENCE_NONE, GNUNET_MQ_PREFERENCE_RELIABILITY, and type.

◆ GNUNET_notification_context_create()

struct GNUNET_NotificationContext* GNUNET_notification_context_create ( unsigned int  queue_length)

Create a new notification context.

Parameters
queue_lengthmaximum number of messages to keep in the notification queue; optional messages are dropped if the queue gets longer than this number of messages
Returns
handle to the notification context

Definition at line 121 of file nc.c.

122 {
124 
126  nc->queue_length = queue_length;
127  return nc;
128 }
static struct GNUNET_PEERINFO_NotifyContext * nc
Iterator context.
The notification context is the key datastructure for a convenience API used for transmission of noti...
Definition: nc.c:76
unsigned int queue_length
Maximum number of optional messages to queue per subscriber.
Definition: nc.c:90

References GNUNET_new, nc, and GNUNET_NotificationContext::queue_length.

Referenced by GAS_performance_init(), GSC_KX_init(), and run().

Here is the caller graph for this function:

◆ GNUNET_notification_context_destroy()

void GNUNET_notification_context_destroy ( struct GNUNET_NotificationContext nc)

Destroy the context, force disconnect for all subscribers.

Parameters
nccontext to destroy.

Definition at line 137 of file nc.c.

138 {
139  struct SubscriberList *pos;
140 
141  while (NULL != (pos = nc->subscribers_head))
142  {
143  GNUNET_CONTAINER_DLL_remove (nc->subscribers_head,
144  nc->subscribers_tail,
145  pos);
147  GNUNET_free (pos);
148  }
149  GNUNET_free (nc);
150 }
Lists of subscribers we manage for notifications.
Definition: nc.c:38
struct GNUNET_MQ_DestroyNotificationHandle * mq_nh
Handle where we registered with mq to be told about the MQ's destruction.
Definition: nc.c:58

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_destroy_notify_cancel(), SubscriberList::mq_nh, and nc.

Referenced by cleanup_task(), do_shutdown(), GAS_performance_done(), GSC_KX_done(), and shutdown_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_notification_context_add()

void GNUNET_notification_context_add ( struct GNUNET_NotificationContext nc,
struct GNUNET_MQ_Handle mq 
)

Add a subscriber to the notification context.

Parameters
nccontext to modify
mqmessage queue add

Definition at line 160 of file nc.c.

162 {
163  struct SubscriberList *cl;
164 
165  for (cl = nc->subscribers_head; NULL != cl; cl = cl->next)
166  if (cl->mq == mq)
167  return;
168  /* already present */
169  cl = GNUNET_new (struct SubscriberList);
170  GNUNET_CONTAINER_DLL_insert (nc->subscribers_head,
171  nc->subscribers_tail,
172  cl);
173  cl->nc = nc;
174  cl->mq = mq;
175  cl->mq_nh = GNUNET_MQ_destroy_notify (cl->mq,
177  cl);
178 }
struct GNUNET_MQ_DestroyNotificationHandle * GNUNET_MQ_destroy_notify(struct GNUNET_MQ_Handle *mq, GNUNET_SCHEDULER_TaskCallback cb, void *cb_cls)
Register function to be called whenever mq is being destroyed.
Definition: mq.c:896
static void handle_mq_destroy(void *cls)
Subscriber has disconnected, clean up.
Definition: nc.c:100
struct GNUNET_MQ_Handle * mq
Message queue for the subscriber.
Definition: nc.c:63
struct GNUNET_NotificationContext * nc
Overall context this subscriber belongs to.
Definition: nc.c:52
struct SubscriberList * next
This is a doubly linked list.
Definition: nc.c:42

References GNUNET_CONTAINER_DLL_insert, GNUNET_MQ_destroy_notify(), GNUNET_new, handle_mq_destroy(), mq, SubscriberList::mq, SubscriberList::mq_nh, nc, SubscriberList::nc, and SubscriberList::next.

Referenced by client_connect_cb(), GAS_performance_add_client(), handle_client_monitor_plugins(), handle_monitor(), handle_monitor_start(), handle_notify(), handle_start(), and handle_start_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_notification_context_broadcast()

void GNUNET_notification_context_broadcast ( struct GNUNET_NotificationContext nc,
const struct GNUNET_MessageHeader msg,
int  can_drop 
)

Send a message to all subscribers of this context.

Parameters
nccontext to modify
msgmessage to send
can_dropcan this message be dropped due to queue length limitations

Definition at line 189 of file nc.c.

192 {
193  struct SubscriberList *pos;
194  struct GNUNET_MQ_Envelope *env;
195 
196  for (pos = nc->subscribers_head; NULL != pos; pos = pos->next)
197  {
198  if ((GNUNET_YES == can_drop) &&
199  (GNUNET_MQ_get_length (pos->mq) > nc->queue_length))
200  continue;
202  GNUNET_MQ_send (pos->mq,
203  env);
204  }
205 }
unsigned int GNUNET_MQ_get_length(struct GNUNET_MQ_Handle *mq)
Obtain the current length of the message queue.
Definition: mq.c:292

References env, GNUNET_MQ_get_length(), GNUNET_MQ_msg_copy(), GNUNET_MQ_send(), GNUNET_YES, SubscriberList::mq, msg, nc, and SubscriberList::next.

Referenced by broadcast_status(), monitor_notify_all(), notify_all(), notify_client(), notify_listeners(), plugin_session_info_cb(), and update_network_size_estimate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_notification_context_get_size()

unsigned int GNUNET_notification_context_get_size ( struct GNUNET_NotificationContext nc)

Return active number of subscribers in this context.

Parameters
nccontext to query
Returns
number of current subscribers

Definition at line 215 of file nc.c.

216 {
217  unsigned int num;
218  struct SubscriberList *pos;
219 
220  num = 0;
221  for (pos = nc->subscribers_head; NULL != pos; pos = pos->next)
222  num++;
223  return num;
224 }

References nc, and SubscriberList::next.

Referenced by plugin_session_info_cb().

Here is the caller graph for this function: