GNUnet  0.11.x
gnunet_mq_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2012-2016 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
35 #ifndef GNUNET_MQ_LIB_H
36 #define GNUNET_MQ_LIB_H
37 
38 #include "gnunet_scheduler_lib.h"
39 
52 #define GNUNET_MQ_msg_extra(mvar, esize, type) \
53  GNUNET_MQ_msg_ (((struct GNUNET_MessageHeader **) &(mvar)), \
54  (esize) + sizeof *(mvar), \
55  (type))
56 
67 #define GNUNET_MQ_msg(mvar, type) GNUNET_MQ_msg_extra (mvar, 0, type)
68 
69 
76 #define GNUNET_MQ_msg_header(type) \
77  GNUNET_MQ_msg_ (NULL, sizeof(struct GNUNET_MessageHeader), type)
78 
79 
88 #define GNUNET_MQ_msg_header_extra(mh, esize, type) \
89  GNUNET_MQ_msg_ (&mh, (esize) + sizeof(struct GNUNET_MessageHeader), type)
90 
91 
102 #define GNUNET_MQ_msg_nested_mh(mvar, type, mh) \
103  ({ \
104  struct GNUNET_MQ_Envelope *_ev; \
105  _ev = GNUNET_MQ_msg_nested_mh_ ((struct GNUNET_MessageHeader **) &(mvar), \
106  sizeof(*(mvar)), \
107  (type), \
108  (mh)); \
109  (void) (mvar)->header; /* type check */ \
110  _ev; \
111  })
112 
113 
122 #define GNUNET_MQ_extract_nested_mh(var) \
123  GNUNET_MQ_extract_nested_mh_ ((struct GNUNET_MessageHeader *) (var), \
124  sizeof(*(var)))
125 
126 
135 const struct GNUNET_MessageHeader *
137  uint16_t base_size);
138 
139 
143 struct GNUNET_MQ_Envelope;
144 
145 
152 const struct GNUNET_MessageHeader *
154 
155 
162 const struct GNUNET_MQ_Envelope *
164 
165 
175 struct GNUNET_MQ_Envelope *
177  uint16_t base_size,
178  uint16_t type,
179  const struct GNUNET_MessageHeader *nested_mh);
180 
181 
185 struct GNUNET_MQ_Handle;
186 
187 
192 {
199 
204 
209 
215 
221 };
222 
223 
228 {
234 
239 
244 
249 
254 
268 
278 
286 
294 
299 };
300 
301 
308 typedef void
310  void *cls,
311  const struct GNUNET_MessageHeader *msg);
312 
313 
322 typedef int
324  void *cls,
325  const struct GNUNET_MessageHeader *msg);
326 
327 
336 typedef void
338  const struct GNUNET_MessageHeader *msg,
339  void *impl_state);
340 
341 
351 typedef void
353  void *impl_state);
354 
355 
362 typedef void
364  void *impl_state);
365 
366 
376 typedef void
377 (*GNUNET_MQ_ErrorHandler) (void *cls,
378  enum GNUNET_MQ_Error error);
379 
380 
393 void
395  struct GNUNET_MQ_Envelope **env_tail,
396  struct GNUNET_MQ_Envelope *env);
397 
398 
411 void
413  struct GNUNET_MQ_Envelope **env_tail,
414  struct GNUNET_MQ_Envelope *env);
415 
416 
429 void
430 GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head,
431  struct GNUNET_MQ_Envelope **env_tail,
432  struct GNUNET_MQ_Envelope *env);
433 
434 
447 
448 
463  GNUNET_MQ_MessageCallback agpl_handler,
464  void *agpl_cls);
465 
466 
473 unsigned int
475 
476 
481 {
490 
497 
501  void *cls;
502 
506  uint16_t type;
507 
514  uint16_t expected_size;
515 };
516 
517 
521 #define GNUNET_MQ_handler_end() \
522  { \
523  NULL, NULL, NULL, 0, 0 \
524  }
525 
526 
555 #define GNUNET_MQ_hd_fixed_size(name, code, str, ctx) \
556  ({ \
557  void (*_cb)(void *cls, const str *msg) = &handle_ ## name; \
558  ((struct GNUNET_MQ_MessageHandler){ NULL, \
559  (GNUNET_MQ_MessageCallback) _cb, \
560  (ctx), \
561  (code), \
562  sizeof(str) }); \
563  })
564 
565 
606 #define GNUNET_MQ_hd_var_size(name, code, str, ctx) \
607  __extension__ ({ \
608  int (*_mv)(void *cls, const str *msg) = &check_ ## name; \
609  void (*_cb)(void *cls, const str *msg) = &handle_ ## name; \
610  ((struct GNUNET_MQ_MessageHandler){ (GNUNET_MQ_MessageValidationCallback) \
611  _mv, \
612  (GNUNET_MQ_MessageCallback) _cb, \
613  (ctx), \
614  (code), \
615  sizeof(str) }); \
616  })
617 
618 
629 #define GNUNET_MQ_check_zero_termination(m) \
630  { \
631  const char *str = (const char *) &m[1]; \
632  const struct GNUNET_MessageHeader *hdr = \
633  (const struct GNUNET_MessageHeader *) m; \
634  uint16_t slen = ntohs (hdr->size) - sizeof(*m); \
635  if ((0 == slen) || (memchr (str, 0, slen) != &str[slen - 1])) \
636  { \
637  GNUNET_break (0); \
638  return GNUNET_NO; \
639  } \
640  }
641 
642 
655 #define GNUNET_MQ_check_boxed_message(m) \
656  { \
657  const struct GNUNET_MessageHeader *inbox = \
658  (const struct GNUNET_MessageHeader *) &m[1]; \
659  const struct GNUNET_MessageHeader *hdr = \
660  (const struct GNUNET_MessageHeader *) m; \
661  uint16_t slen = ntohs (hdr->size) - sizeof(*m); \
662  if ((slen < sizeof(struct GNUNET_MessageHeader)) || \
663  (slen != ntohs (inbox->size))) \
664  { \
665  GNUNET_break (0); \
666  return GNUNET_NO; \
667  } \
668  }
669 
670 
683 int
685  const struct GNUNET_MessageHeader *mh);
686 
687 
696 struct GNUNET_MQ_Envelope *
698  uint16_t size,
699  uint16_t type);
700 
701 
708 struct GNUNET_MQ_Envelope *
709 GNUNET_MQ_msg_copy (const struct GNUNET_MessageHeader *hdr);
710 
711 
719 void
721 
722 
730 struct GNUNET_MQ_Envelope *
732 
733 
741 struct GNUNET_MQ_Envelope *
743 
744 
751 struct GNUNET_MQ_Envelope *
753 
754 
763 void
766 
767 
776 
777 
789 
790 
798 struct GNUNET_MQ_Envelope *
800 
801 
808 void
811 
812 
819 unsigned int
821 
822 
830 void
832  struct GNUNET_MQ_Envelope *ev);
833 
834 
842 void
844  const struct GNUNET_MQ_Envelope *ev);
845 
846 
854 void
856 
857 
864 uint32_t
866  void *assoc_data);
867 
868 
876 void *
878  uint32_t request_id);
879 
880 
888 void *
890  uint32_t request_id);
891 
892 
905 struct GNUNET_MQ_Handle *
908  GNUNET_MQ_CancelImpl cancel,
909  void *impl_state,
910  const struct GNUNET_MQ_MessageHandler *handlers,
912  void *cls);
913 
914 
922 void
924  void *handlers_cls);
925 
926 
936 void
939  void *cb_cls);
940 
941 
947 void
949 
950 
956 
957 
970  void *cb_cls);
971 
977 void
980 
981 
992 void
994  const struct GNUNET_MessageHeader *mh);
995 
996 
1007 void
1009  enum GNUNET_MQ_Error error);
1010 
1011 
1022 void
1024 
1025 
1036 void
1038 
1039 
1054 void *
1056 
1057 
1067 const struct GNUNET_MessageHeader *
1069 
1070 
1077 {
1082 
1088 
1094 
1100 
1104 #define GNUNET_MQ_PREFERENCE_COUNT 4
1105 };
1106 
1107 
1116 const char *
1118 
1119 
1120 #endif
1121  /* end of group mq */
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
static void error_handler(void *cls, enum GNUNET_MQ_Error error)
We encountered an error handling the MQ to the ATS service.
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
static void destroy(void *cls)
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.
Definition: mq.c:443
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_(struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type)
Create a new envelope.
Definition: mq.c:645
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:894
void GNUNET_MQ_set_options(struct GNUNET_MQ_Handle *mq, enum GNUNET_MQ_PriorityPreferences pp)
Set application-specific options for this queue.
Definition: mq.c:1083
void GNUNET_MQ_send_cancel(struct GNUNET_MQ_Envelope *ev)
Cancel sending the message.
Definition: mq.c:929
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.
Definition: mq.c:1212
void GNUNET_MQ_env_set_options(struct GNUNET_MQ_Envelope *env, enum GNUNET_MQ_PriorityPreferences pp)
Set application-specific options for this envelope.
Definition: mq.c:1022
unsigned int GNUNET_MQ_get_length(struct GNUNET_MQ_Handle *mq)
Obtain the current length of the message queue.
Definition: mq.c:337
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:1126
const struct GNUNET_MQ_Envelope * GNUNET_MQ_env_next(const struct GNUNET_MQ_Envelope *env)
Return next envelope in queue.
Definition: mq.c:1110
GNUNET_MQ_Error
Error codes for the queue.
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.
Definition: mq.c:405
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:300
int(* GNUNET_MQ_MessageValidationCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message needs to be validated.
uint16_t expected_size
Expected size of messages of this type.
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 c...
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:355
void(* GNUNET_MQ_DestroyImpl)(struct GNUNET_MQ_Handle *mq, void *impl_state)
Signature of functions implementing the destruction of a message queue.
struct GNUNET_MQ_Envelope * GNUNET_MQ_get_last_envelope(struct GNUNET_MQ_Handle *mq)
Function to obtain the last envelope in the queue.
Definition: mq.c:1004
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 ...
Definition: mq.c:1170
void * GNUNET_MQ_impl_state(struct GNUNET_MQ_Handle *mq)
Get the implementation state associated with the message queue.
Definition: mq.c:638
const char * GNUNET_MQ_preference_to_string(enum GNUNET_MQ_PreferenceKind type)
Convert an enum GNUNET_MQ_PreferenceType to a string.
Definition: mq.c:1312
void GNUNET_MQ_discard(struct GNUNET_MQ_Envelope *mqm)
Discard the message queue message, free all allocated resources.
Definition: mq.c:323
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.
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.
Definition: mq.c:565
GNUNET_MQ_PreferenceKind
Enum defining all known preference categories.
void GNUNET_MQ_impl_send_continue(struct GNUNET_MQ_Handle *mq)
Call the send implementation for the next queued message, if any.
Definition: mq.c:499
void * GNUNET_MQ_assoc_remove(struct GNUNET_MQ_Handle *mq, uint32_t request_id)
Remove the association for a request_id.
Definition: mq.c:765
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 e...
Definition: mq.c:1058
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 m...
Definition: mq.c:202
GNUNET_MQ_MessageValidationCallback mv
Callback to validate a message of the specified type.
GNUNET_MQ_PriorityPreferences
Per envelope preferences and priorities.
void GNUNET_MQ_destroy_notify_cancel(struct GNUNET_MQ_DestroyNotificationHandle *dnh)
Cancel registration from GNUNET_MQ_destroy_notify().
Definition: mq.c:1147
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.
Definition: mq.c:787
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:666
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.
Definition: mq.c:721
void(* GNUNET_MQ_MessageCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message has been received.
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 h...
Definition: mq.c:229
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.
Definition: mq.c:749
const struct GNUNET_MessageHeader * GNUNET_MQ_impl_current(struct GNUNET_MQ_Handle *mq)
Get the message that should currently be sent.
Definition: mq.c:615
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_get_options(struct GNUNET_MQ_Envelope *env)
Get performance preferences set for this envelope.
Definition: mq.c:1037
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 #gn...
Definition: mq.c:532
struct GNUNET_MQ_Envelope * GNUNET_MQ_env_copy(struct GNUNET_MQ_Envelope *env)
Function to copy an envelope.
Definition: mq.c:425
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.
Definition: mq.c:596
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.
Definition: mq.c:1261
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 ...
Definition: mq.c:1191
uint16_t type
Type of the message this handler covers, in host byte order.
void(* GNUNET_MQ_CancelImpl)(struct GNUNET_MQ_Handle *mq, void *impl_state)
Implementation function that cancels the currently sent message.
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.
struct GNUNET_MQ_MessageHandler * GNUNET_MQ_copy_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Copy an array of handlers.
Definition: mq.c:1231
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.
Definition: mq.c:991
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:688
unsigned int GNUNET_MQ_count_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Count the handlers in a handler array.
Definition: mq.c:1291
const struct GNUNET_MessageHeader * GNUNET_MQ_env_get_msg(const struct GNUNET_MQ_Envelope *env)
Obtain message contained in envelope.
Definition: mq.c:1097
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:837
@ 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_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.
@ 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.
void(* GNUNET_SCHEDULER_TaskCallback)(void *cls)
Signature of the main function of a task.
static unsigned int size
Size of the "table".
Definition: peer.c:67
Handle we return for callbacks registered to be notified when GNUNET_MQ_destroy() is called on a queu...
Definition: mq.c:803
GNUNET_SCHEDULER_TaskCallback cb
Function to call.
Definition: mq.c:822
void * cb_cls
Closure for cb.
Definition: mq.c:827
Handle to a message queue.
Definition: mq.c:86
void * impl_state
Implementation-specific state.
Definition: mq.c:111
Message handler for a specific message type.
Header for all communications.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model