GNUnet  0.10.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 {
229 
235 
240 
245 
250 
255 
269 
279 
287 
295 
300 
301 };
302 
303 
310 typedef void (*GNUNET_MQ_MessageCallback) (
311  void *cls,
312  const struct GNUNET_MessageHeader *msg);
313 
314 
324  void *cls,
325  const struct GNUNET_MessageHeader *msg);
326 
327 
336 typedef void (*GNUNET_MQ_SendImpl) (struct GNUNET_MQ_Handle *mq,
337  const struct GNUNET_MessageHeader *msg,
338  void *impl_state);
339 
340 
350 typedef void (*GNUNET_MQ_DestroyImpl) (struct GNUNET_MQ_Handle *mq,
351  void *impl_state);
352 
353 
360 typedef void (*GNUNET_MQ_CancelImpl) (struct GNUNET_MQ_Handle *mq,
361  void *impl_state);
362 
363 
373 typedef void (*GNUNET_MQ_ErrorHandler) (void *cls, enum GNUNET_MQ_Error error);
374 
375 
388 void
390  struct GNUNET_MQ_Envelope **env_tail,
391  struct GNUNET_MQ_Envelope *env);
392 
393 
406 void
407 GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head,
408  struct GNUNET_MQ_Envelope **env_tail,
409  struct GNUNET_MQ_Envelope *env);
410 
411 
424 
425 
440  GNUNET_MQ_MessageCallback agpl_handler,
441  void *agpl_cls);
442 
443 
450 unsigned int
452 
453 
458 {
467 
474 
478  void *cls;
479 
483  uint16_t type;
484 
491  uint16_t expected_size;
492 };
493 
494 
498 #define GNUNET_MQ_handler_end() \
499  { \
500  NULL, NULL, NULL, 0, 0 \
501  }
502 
503 
532 #define GNUNET_MQ_hd_fixed_size(name, code, str, ctx) \
533  ({ \
534  void (*_cb) (void *cls, const str *msg) = &handle_##name; \
535  ((struct GNUNET_MQ_MessageHandler){NULL, \
536  (GNUNET_MQ_MessageCallback) _cb, \
537  (ctx), \
538  (code), \
539  sizeof (str)}); \
540  })
541 
542 
583 #define GNUNET_MQ_hd_var_size(name, code, str, ctx) \
584  __extension__({ \
585  int (*_mv) (void *cls, const str *msg) = &check_##name; \
586  void (*_cb) (void *cls, const str *msg) = &handle_##name; \
587  ((struct GNUNET_MQ_MessageHandler){(GNUNET_MQ_MessageValidationCallback) \
588  _mv, \
589  (GNUNET_MQ_MessageCallback) _cb, \
590  (ctx), \
591  (code), \
592  sizeof (str)}); \
593  })
594 
595 
606 #define GNUNET_MQ_check_zero_termination(m) \
607  { \
608  const char *str = (const char *) &m[1]; \
609  const struct GNUNET_MessageHeader *hdr = \
610  (const struct GNUNET_MessageHeader *) m; \
611  uint16_t slen = ntohs (hdr->size) - sizeof (*m); \
612  if ((0 == slen) || (memchr (str, 0, slen) != &str[slen - 1])) \
613  { \
614  GNUNET_break (0); \
615  return GNUNET_NO; \
616  } \
617  }
618 
619 
632 #define GNUNET_MQ_check_boxed_message(m) \
633  { \
634  const struct GNUNET_MessageHeader *inbox = \
635  (const struct GNUNET_MessageHeader *) &m[1]; \
636  const struct GNUNET_MessageHeader *hdr = \
637  (const struct GNUNET_MessageHeader *) m; \
638  uint16_t slen = ntohs (hdr->size) - sizeof (*m); \
639  if ((slen < sizeof (struct GNUNET_MessageHeader)) || \
640  (slen != ntohs (inbox->size))) \
641  { \
642  GNUNET_break (0); \
643  return GNUNET_NO; \
644  } \
645  }
646 
647 
660 int
662  const struct GNUNET_MessageHeader *mh);
663 
664 
673 struct GNUNET_MQ_Envelope *
675  uint16_t size,
676  uint16_t type);
677 
678 
685 struct GNUNET_MQ_Envelope *
686 GNUNET_MQ_msg_copy (const struct GNUNET_MessageHeader *hdr);
687 
688 
696 void
698 
699 
707 struct GNUNET_MQ_Envelope *
709 
710 
718 struct GNUNET_MQ_Envelope *
720 
721 
728 struct GNUNET_MQ_Envelope *
730 
731 
740 void
743 
744 
753 
754 
766 
767 
775 struct GNUNET_MQ_Envelope *
777 
778 
785 void
788 
789 
796 unsigned int
798 
799 
807 void
808 GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev);
809 
810 
818 void
820  const struct GNUNET_MQ_Envelope *ev);
821 
822 
830 void
832 
833 
840 uint32_t
841 GNUNET_MQ_assoc_add (struct GNUNET_MQ_Handle *mq, void *assoc_data);
842 
843 
851 void *
852 GNUNET_MQ_assoc_get (struct GNUNET_MQ_Handle *mq, uint32_t request_id);
853 
854 
862 void *
863 GNUNET_MQ_assoc_remove (struct GNUNET_MQ_Handle *mq, uint32_t request_id);
864 
865 
878 struct GNUNET_MQ_Handle *
881  GNUNET_MQ_CancelImpl cancel,
882  void *impl_state,
883  const struct GNUNET_MQ_MessageHandler *handlers,
885  void *cls);
886 
887 
895 void
897  void *handlers_cls);
898 
899 
909 void
912  void *cb_cls);
913 
914 
920 void
922 
923 
929 
930 
943  void *cb_cls);
944 
950 void
953 
954 
965 void
967  const struct GNUNET_MessageHeader *mh);
968 
969 
980 void
982  enum GNUNET_MQ_Error error);
983 
984 
995 void
997 
998 
1009 void
1011 
1012 
1027 void *
1029 
1030 
1040 const struct GNUNET_MessageHeader *
1042 
1043 
1050 {
1051 
1056 
1062 
1068 
1074 
1078 #define GNUNET_MQ_PREFERENCE_COUNT 4
1079 
1080 };
1081 
1082 
1091 const char *
1093 
1094 
1095 #endif
1096  /* end of group mq */
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:1153
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:1041
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:987
Handle we return for callbacks registered to be notified when GNUNET_MQ_destroy() is called on a queu...
Definition: mq.c:789
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:653
static void error_handler(void *cls, enum GNUNET_MQ_Error error)
We encountered an error handling the MQ to the ATS service.
void * impl_state
Implementation-specific state.
Definition: mq.c:111
Urgent traffic (local peer, i.e.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
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:1109
const struct GNUNET_MessageHeader * GNUNET_MQ_env_get_msg(const struct GNUNET_MQ_Envelope *env)
Obtain message contained in envelope.
Definition: mq.c:1080
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
uint16_t expected_size
Expected size of messages of this type.
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:708
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...
GNUNET_MQ_Error
Error codes for the queue.
We received a message for which we have no matching handler.
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
struct GNUNET_MQ_MessageHandler * GNUNET_MQ_copy_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Copy an array of handlers.
Definition: mq.c:1193
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:1005
No preference was expressed.
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
GNUNET_MQ_PriorityPreferences
Per envelope preferences and priorities.
const struct GNUNET_MessageHeader * GNUNET_MQ_impl_current(struct GNUNET_MQ_Handle *mq)
Get the message that should currently be sent.
Definition: mq.c:602
const struct GNUNET_MQ_Envelope * GNUNET_MQ_env_next(const struct GNUNET_MQ_Envelope *env)
Return next envelope in queue.
Definition: mq.c:1093
void(* GNUNET_SCHEDULER_TaskCallback)(void *cls)
Signature of the main function of a task.
Flag to indicate that low latency is important.
enum GNUNET_MQ_PriorityPreferences GNUNET_MQ_env_get_options(struct GNUNET_MQ_Envelope *env)
Get performance preferences set for this envelope.
Definition: mq.c:1020
Best-effort traffic (i.e.
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:583
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:519
uint16_t type
Type of the message this handler covers, in host byte order.
Flag to indicate that high bandwidth is desired.
GNUNET_MQ_PreferenceKind
Enum defining all known preference categories.
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:552
void * cls
Closure for mv and cb.
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
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:774
GNUNET_MQ_MessageValidationCallback mv
Callback to validate a message of the specified type.
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:675
unsigned int GNUNET_MQ_get_length(struct GNUNET_MQ_Handle *mq)
Obtain the current length of the message queue.
Definition: mq.c:335
FIXME: document!
The preferred transmission for this envelope focuses on maximizing bandwidth.
Failed to read message from the network.
void * GNUNET_MQ_impl_state(struct GNUNET_MQ_Handle *mq)
Get the implementation state associated with the message queue.
Definition: mq.c:625
void(* GNUNET_MQ_DestroyImpl)(struct GNUNET_MQ_Handle *mq, void *impl_state)
Signature of functions implementing the destruction of a message queue.
GNUNET_MQ_MessageCallback cb
Callback, called every time a new message of the specified type has been receied. ...
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
We received a message that was malformed and thus could not be passed to its handler.
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:1223
struct GNUNET_MQ_Envelope * GNUNET_MQ_msg_(struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type)
Create a new envelope.
Definition: mq.c:632
Message handler for a specific message type.
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:1174
unsigned int GNUNET_MQ_count_handlers(const struct GNUNET_MQ_MessageHandler *handlers)
Count the handlers in a handler array.
Definition: mq.c:1253
void GNUNET_MQ_discard(struct GNUNET_MQ_Envelope *mqm)
Discard the message queue message, free all allocated resources.
Definition: mq.c:321
FIXME: document!
static unsigned int size
Size of the "table".
Definition: peer.c:67
Lowest priority, i.e.
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
void(* GNUNET_MQ_CancelImpl)(struct GNUNET_MQ_Handle *mq, void *impl_state)
Implementation function that cancels the currently sent message.
Bit mask to apply to extract the priority bits.
void(* GNUNET_MQ_MessageCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message has been received.
Handle to a message queue.
Definition: mq.c:85
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:1066
const char * GNUNET_MQ_preference_to_string(enum GNUNET_MQ_PreferenceKind type)
Convert an enum GNUNET_MQ_PreferenceType to a string.
Definition: mq.c:1274
int(* GNUNET_MQ_MessageValidationCallback)(void *cls, const struct GNUNET_MessageHeader *msg)
Called when a message needs to be validated.
void * GNUNET_MQ_assoc_remove(struct GNUNET_MQ_Handle *mq, uint32_t request_id)
Remove the association for a request_id.
Definition: mq.c:752
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. ...
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:432
The preferred transmission for this envelope foces on minimizing latency.
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
Flag to indicate that out-of-order delivery is OK.
void GNUNET_MQ_destroy_notify_cancel(struct GNUNET_MQ_DestroyNotificationHandle *dnh)
Cancel registration from GNUNET_MQ_destroy_notify().
Definition: mq.c:1130
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:881
Flag to indicate that CORKing is acceptable.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Header for all communications.
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:974
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:824
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:353
Flag to indicate that unreliable delivery is acceptable.
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:394
static void destroy(void *cls)
Highest priority, control traffic (i.e.
struct GNUNET_MQ_Envelope * GNUNET_MQ_env_copy(struct GNUNET_MQ_Envelope *env)
Function to copy an envelope.
Definition: mq.c:414
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:486
void GNUNET_MQ_send_cancel(struct GNUNET_MQ_Envelope *ev)
Cancel sending the message.
Definition: mq.c:916
void * cb_cls
Closure for cb.
Definition: mq.c:814
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:736
The preferred transmission for this envelope foces on reliability.