src/include/gnunet_mq_lib.h

   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
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Florian Dold
  23  * @author Christian Grothoff
  24  *
  25  * @file
  26  * General-purpose message queue
  27  *
  28  * @defgroup mq  MQ library
  29  * General-purpose message queue
  30  *
  31  * @see [Documentation](https://gnunet.org/message-queue-api)
  32  *
  33  * @{
  34  */
  35 #ifndef GNUNET_MQ_H
  36 #define GNUNET_MQ_H
  37
  38
  39 /**
  40  * Allocate an envelope, with extra space allocated after the space needed
  41  * by the message struct.
  42  * The allocated message will already have the type and size field set.
  43  *
  44  * @param mvar variable to store the allocated message in;
  45  *             must have a header field;
  46  *             can be NULL
  47  * @param esize extra space to allocate after the message
  48  * @param type type of the message
  49  * @return the MQ message
  50  */
  51 #define GNUNET_MQ_msg_extra(mvar, esize, type) GNUNET_MQ_msg_(((struct GNUNET_MessageHeader**) &(mvar)), (esize) + sizeof *(mvar), (type))
  52
  53 /**
  54  * Allocate a GNUNET_MQ_Envelope.
  55  * The contained message will already have the type and size field set.
  56  *
  57  * @param mvar variable to store the allocated message in;
  58  *             must have a header field;
  59  *             can be NULL
  60  * @param type type of the message
  61  * @return the allocated envelope
  62  */
  63 #define GNUNET_MQ_msg(mvar, type) GNUNET_MQ_msg_extra(mvar, 0, type)
  64
  65
  66 /**
  67  * Allocate a GNUNET_MQ_Envelope, where the message only consists of a header.
  68  * The allocated message will already have the type and size field set.
  69  *
  70  * @param type type of the message
  71  */
  72 #define GNUNET_MQ_msg_header(type) GNUNET_MQ_msg_ (NULL, sizeof (struct GNUNET_MessageHeader), type)
  73
  74
  75 /**
  76  * Allocate a GNUNET_MQ_Envelope, where the message only consists of a header and extra space.
  77  * The allocated message will already have the type and size field set.
  78  *
  79  * @param mh pointer that will changed to point at to the allocated message header
  80  * @param esize extra space to allocate after the message header
  81  * @param type type of the message
  82  */
  83 #define GNUNET_MQ_msg_header_extra(mh, esize, type) GNUNET_MQ_msg_ (&mh, (esize) + sizeof (struct GNUNET_MessageHeader), type)
  84
  85
  86 /**
  87  * Allocate a GNUNET_MQ_Envelope, and append a payload message after the given
  88  * message struct.
  89  *
  90  * @param mvar pointer to a message struct, will be changed to point at the newly allocated message,
  91  *        whose size is 'sizeof(*mvar) + ntohs (mh->size)'
  92  * @param type message type of the allocated message, has no effect on the nested message
  93  * @param mh message to nest
  94  * @return a newly allocated 'struct GNUNET_MQ_Envelope *'
  95  */
  96 #define GNUNET_MQ_msg_nested_mh(mvar, type, mh) \
  97   ({struct GNUNET_MQ_Envelope *_ev;\
  98     _ev = GNUNET_MQ_msg_nested_mh_((struct GNUNET_MessageHeader**) &(mvar),\
  99                                    sizeof (*(mvar)),\
 100                                    (type),\
 101                                    (mh));\
 102    (void)(mvar)->header; /* type check */\
 103    _ev;})
 104
 105
 106 /**
 107  * Return a pointer to the message at the end of the given message.
 108  *
 109  * @param var pointer to a message struct, the type of the expression determines the base size,
 110  *        the space after the base size is the nested message
 111  * @return a 'struct GNUNET_MessageHeader *' that points at the nested message of the given message,
 112  *         or NULL if the given message in @a var does not have any space after the message struct
 113  */
 114 #define GNUNET_MQ_extract_nested_mh(var) GNUNET_MQ_extract_nested_mh_ ((struct GNUNET_MessageHeader *) (var), sizeof (*(var)))
 115
 116
 117 /**
 118  * Implementation of the #GNUNET_MQ_extract_nexted_mh macro.
 119  *
 120  * @param mh message header to extract nested message header from
 121  * @param base_size size of the message before the nested message's header appears
 122  * @return pointer to the nested message, does not copy the message
 123  *         OR NULL in case of a malformed message.
 124  */
 125 const struct GNUNET_MessageHeader *
 126 GNUNET_MQ_extract_nested_mh_ (const struct GNUNET_MessageHeader *mh,
 127                               uint16_t base_size);
 128
 129
 130 /**
 131  * Opaque handle to an envelope.
 132  */
 133 struct GNUNET_MQ_Envelope;
 134
 135
 136 /**
 137  * Implementation of the #GNUNET_MQ_msg_nested_mh macro.
 138  *
 139  * @param mhp pointer to the message header pointer that will be changed to allocate at
 140  *        the newly allocated space for the message.
 141  * @param base_size size of the data before the nested message
 142  * @param type type of the message in the envelope
 143  * @param nested_mh the message to append to the message after base_size
 144  */
 145 struct GNUNET_MQ_Envelope *
 146 GNUNET_MQ_msg_nested_mh_ (struct GNUNET_MessageHeader **mhp,
 147                           uint16_t base_size,
 148                           uint16_t type,
 149                           const struct GNUNET_MessageHeader *nested_mh);
 150
 151
 152 /**
 153  * Opaque handle to a message queue.
 154  */
 155 struct GNUNET_MQ_Handle;
 156
 157
 158 /**
 159  * Error codes for the queue.
 160  */
 161 enum GNUNET_MQ_Error
 162 {
 163   /**
 164    * Failed to read message from the network.
 165    * FIXME: Likely not properly distinguished
 166    * from TIMEOUT case in the code!
 167    */
 168   GNUNET_MQ_ERROR_READ = 1,
 169
 170   /**
 171    * FIXME: document!
 172    */
 173   GNUNET_MQ_ERROR_WRITE = 2,
 174
 175   /**
 176    * FIXME: document!
 177    */
 178   GNUNET_MQ_ERROR_TIMEOUT = 4,
 179
 180   /**
 181    * We received a message that was malformed and thus
 182    * could not be passed to its handler.
 183    */
 184   GNUNET_MQ_ERROR_MALFORMED = 8,
 185
 186   /**
 187    * We received a message for which we have no matching
 188    * handler.
 189    */
 190   GNUNET_MQ_ERROR_NO_MATCH = 16
 191 };
 192
 193
 194 /**
 195  * Called when a message has been received.
 196  *
 197  * @param cls closure
 198  * @param msg the received message
 199  */
 200 typedef void
 201 (*GNUNET_MQ_MessageCallback) (void *cls,
 202                               const struct GNUNET_MessageHeader *msg);
 203
 204
 205 /**
 206  * Called when a message needs to be validated.
 207  *
 208  * @param cls closure
 209  * @param msg the received message
 210  * @return #GNUNET_OK if the message is well-formed,
 211  *         #GNUNET_SYSERR if not
 212  */
 213 typedef int
 214 (*GNUNET_MQ_MessageValidationCallback) (void *cls,
 215                                         const struct GNUNET_MessageHeader *msg);
 216
 217
 218 /**
 219  * Signature of functions implementing the
 220  * sending functionality of a message queue.
 221  *
 222  * @param mq the message queue
 223  * @param msg the message to send
 224  * @param impl_state state of the implementation
 225  */
 226 typedef void
 227 (*GNUNET_MQ_SendImpl) (struct GNUNET_MQ_Handle *mq,
 228                        const struct GNUNET_MessageHeader *msg,
 229                        void *impl_state);
 230
 231
 232 /**
 233  * Signature of functions implementing the
 234  * destruction of a message queue.
 235  * Implementations must not free @a mq, but should
 236  * take care of @a impl_state.
 237  *
 238  * @param mq the message queue to destroy
 239  * @param impl_state state of the implementation
 240  */
 241 typedef void
 242 (*GNUNET_MQ_DestroyImpl) (struct GNUNET_MQ_Handle *mq,
 243                           void *impl_state);
 244
 245
 246 /**
 247  * Implementation function that cancels the currently sent message.
 248  *
 249  * @param mq message queue
 250  * @param impl_state state specific to the implementation
 251  */
 252 typedef void
 253 (*GNUNET_MQ_CancelImpl) (struct GNUNET_MQ_Handle *mq,
 254                          void *impl_state);
 255
 256
 257 /**
 258  * Generic error handler, called with the appropriate
 259  * error code and the same closure specified at the creation of
 260  * the message queue.
 261  * Not every message queue implementation supports an error handler.
 262  *
 263  * @param cls closure
 264  * @param error error code
 265  */
 266 typedef void
 267 (*GNUNET_MQ_ErrorHandler) (void *cls,
 268                            enum GNUNET_MQ_Error error);
 269
 270
 271 /**
 272  * Message handler for a specific message type.
 273  */
 274 struct GNUNET_MQ_MessageHandler
 275 {
 276   /**
 277    * Callback to validate a message of the specified @e type.
 278    * The closure given to @e mv will be this struct (not @e ctx).
 279    * Using NULL means only size-validation using
 280    * @e expected_size.  In this case, @e expected_size must
 281    * be non-zero.
 282    */
 283   GNUNET_MQ_MessageValidationCallback mv;
 284
 285   /**
 286    * Callback, called every time a new message of
 287    * the specified @e type has been receied.
 288    * The closure given to @e mv will be this struct (not @e ctx).
 289    */
 290   GNUNET_MQ_MessageCallback cb;
 291
 292   /**
 293    * Closure for @e mv and @e cb.
 294    */
 295   void *cls;
 296
 297   /**
 298    * Type of the message this handler covers, in host byte order.
 299    */
 300   uint16_t type;
 301
 302   /**
 303    * Expected size of messages of this type.  Minimum size of the
 304    * message if @e mv is non-NULL.  Messages of the given type will be
 305    * discarded (and the connection closed with an error reported to
 306    * the application) if they do not have the right size.
 307    */
 308   uint16_t expected_size;
 309 };
 310
 311
 312 /**
 313  * End-marker for the handlers array
 314  */
 315 #define GNUNET_MQ_handler_end() { NULL, NULL, NULL, 0, 0 }
 316
 317
 318 /**
 319  * Defines a static function @a name which takes as a single argument
 320  * a message handler for fixed-sized messages of type @a code and with
 321  * a message type argument of @a str.  Given such an argument, the
 322  * function @name will return a `struct GNUNET_MQ_MessageHandler`
 323  * for the given message type.
 324  *
 325  * The macro is to be used as follows:
 326  * <code>
 327  * struct GNUNET_MessageTest { ... }; // must be fixed size
 328  * static void
 329  * handle_test_message (void *cls,
 330  *                      const struct GNUNET_MessageTest *msg)
 331  * { ... }
 332  *
 333  * struct GNUNET_MQ_MessageHandler handlers[] = {
 334  *   GNUNET_MQ_hd_fixed_size(test_message,
 335  *                           GNUNET_MESSAGE_TYPE_TEST,
 336  *                           struct GNUNET_MessageTest,
 337  *                           "context"),
 338  *   GNUNET_MQ_handler_end()
 339  * };
 340  *
 341  * @param name unique basename for the functions
 342  * @param code message type constant
 343  * @param str type of the message (a struct)
 344  * @param ctx context for the callbacks
 345  */
 346 #define GNUNET_MQ_hd_fixed_size(name,code,str,ctx)           \
 347   ({                                                         \
 348     void (*_cb)(void *cls, const str *msg) = &handle_##name; \
 349     ((struct GNUNET_MQ_MessageHandler) {                     \
 350       NULL, (GNUNET_MQ_MessageCallback) _cb,                 \
 351       (ctx), (code), sizeof (str) });                        \
 352   })
 353
 354
 355 /**
 356  * Defines a static function @a name which takes two arguments and a
 357  * context-pointer for validating and handling variable-sized messages
 358  * of type @a code and with a message type argument of @a str.  Given
 359  * such arguments, the function @name will return a `struct
 360  * GNUNET_MQ_MessageHandler` for the given message type.
 361  *
 362  * The macro is to be used as follows:
 363  * <code>
 364  * struct GNUNET_MessageTest { ... }; // can be variable size
 365  * static int
 366  * check_test (void *cls,
 367  *             const struct GNUNET_MessageTest *msg)
 368  * {
 369  *   const char *ctx = cls;
 370  *   GNUNET_assert (0 == strcmp ("context", ctx));
 371  *   // ...
 372  * }
 373  * static void
 374  * handle_test (void *cls,
 375  *              const struct GNUNET_MessageTest *msg)
 376  * {
 377  *   const char *ctx = cls;
 378  *   GNUNET_assert (0 == strcmp ("context", ctx));
 379  *   // ...
 380  * }
 381  *
 382  * struct GNUNET_MQ_MessageHandler handlers[] = {
 383  *   GNUNET_MQ_hd_var_size(test_message,
 384  *                         GNUNET_MESSAGE_TYPE_TEST,
 385  *                         struct GNUNET_MessageTest,
 386  *                         "context"),
 387  *   GNUNET_MQ_handler_end()
 388  * };
 389  *
 390  * @param name unique basename for the functions
 391  * @param code message type constant
 392  * @param str type of the message (a struct)
 393  * @param ctx context for the callbacks
 394  */
 395 #define GNUNET_MQ_hd_var_size(name,code,str,ctx)             \
 396   __extension__ ({                                           \
 397     int (*_mv)(void *cls, const str *msg) = &check_##name;   \
 398     void (*_cb)(void *cls, const str *msg) = &handle_##name; \
 399     ((struct GNUNET_MQ_MessageHandler)                       \
 400       { (GNUNET_MQ_MessageValidationCallback) _mv,           \
 401         (GNUNET_MQ_MessageCallback) _cb,                     \
 402         (ctx), (code), sizeof (str) });                      \
 403   })
 404
 405
 406 /**
 407  * Create a new envelope.
 408  *
 409  * @param mhp message header to store the allocated message header in, can be NULL
 410  * @param size size of the message to allocate
 411  * @param type type of the message, will be set in the allocated message
 412  * @return the allocated MQ message
 413  */
 414 struct GNUNET_MQ_Envelope *
 415 GNUNET_MQ_msg_ (struct GNUNET_MessageHeader **mhp,
 416
 417                 uint16_t size,
 418                 uint16_t type);
 419
 420
 421 /**
 422  * Create a new envelope by copying an existing message.
 423  *
 424  * @param hdr header of the message to copy
 425  * @return envelope containing @a hdr
 426  */
 427 struct GNUNET_MQ_Envelope *
 428 GNUNET_MQ_msg_copy (const struct GNUNET_MessageHeader *hdr);
 429
 430
 431 /**
 432  * Discard the message queue message, free all
 433  * allocated resources. Must be called in the event
 434  * that a message is created but should not actually be sent.
 435  *
 436  * @param mqm the message to discard
 437  */
 438 void
 439 GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *mqm);
 440
 441
 442 /**
 443  * Function to obtain the current envelope
 444  * from within #GNUNET_MQ_SendImpl implementations.
 445  *
 446  * @param mq message queue to interrogate
 447  * @return the current envelope
 448  */
 449 struct GNUNET_MQ_Envelope *
 450 GNUNET_MQ_get_current_envelope (struct GNUNET_MQ_Handle *mq);
 451
 452
 453 /**
 454  * Function to obtain the last envelope in the queue.
 455  *
 456  * @param mq message queue to interrogate
 457  * @return the last envelope in the queue
 458  */
 459 struct GNUNET_MQ_Envelope *
 460 GNUNET_MQ_get_last_envelope (struct GNUNET_MQ_Handle *mq);
 461
 462
 463 /**
 464  * Set application-specific options for this envelope.
 465  * Overrides the options set for the queue with
 466  * #GNUNET_MQ_set_options() for this message only.
 467  *
 468  * @param env message to set options for
 469  * @param flags flags to use (meaning is queue-specific)
 470  * @param extra additional buffer for further data (also queue-specific)
 471  */
 472 void
 473 GNUNET_MQ_env_set_options (struct GNUNET_MQ_Envelope *env,
 474                            uint64_t flags,
 475                            const void *extra);
 476
 477
 478 /**
 479  * Get application-specific options for this envelope.
 480  *
 481  * @param env message to set options for
 482  * @param[out] flags set to flags to use (meaning is queue-specific)
 483  * @return extra additional buffer for further data (also queue-specific)
 484  */
 485 const void *
 486 GNUNET_MQ_env_get_options (struct GNUNET_MQ_Envelope *env,
 487                            uint64_t *flags);
 488
 489
 490 /**
 491  * Set application-specific options for this queue.
 492  *
 493  * @param mq message queue to set options for
 494  * @param flags flags to use (meaning is queue-specific)
 495  * @param extra additional buffer for further data (also queue-specific)
 496  */
 497 void
 498 GNUNET_MQ_set_options (struct GNUNET_MQ_Handle *mq,
 499                        uint64_t flags,
 500                        const void *extra);
 501
 502
 503 /**
 504  * Obtain the current length of the message queue.
 505  *
 506  * @param mq queue to inspect
 507  * @return number of queued, non-transmitted messages
 508  */
 509 unsigned int
 510 GNUNET_MQ_get_length (struct GNUNET_MQ_Handle *mq);
 511
 512
 513 /**
 514  * Send a message with the given message queue.
 515  * May only be called once per message.
 516  *
 517  * @param mq message queue
 518  * @param ev the envelope with the message to send.
 519  */
 520 void
 521 GNUNET_MQ_send (struct GNUNET_MQ_Handle *mq,
 522                 struct GNUNET_MQ_Envelope *ev);
 523
 524
 525 /**
 526  * Send a copy of a message with the given message queue.
 527  * Can be called repeatedly on the same envelope.
 528  *
 529  * @param mq message queue
 530  * @param ev the envelope with the message to send.
 531  */
 532 void
 533 GNUNET_MQ_send_copy (struct GNUNET_MQ_Handle *mq,
 534                      const struct GNUNET_MQ_Envelope *ev);
 535
 536
 537 /**
 538  * Cancel sending the message. Message must have been sent with
 539  * #GNUNET_MQ_send before.  May not be called after the notify sent
 540  * callback has been called
 541  *
 542  * @param ev queued envelope to cancel
 543  */
 544 void
 545 GNUNET_MQ_send_cancel (struct GNUNET_MQ_Envelope *ev);
 546
 547
 548 /**
 549  * Associate the assoc_data in @a mq with a unique request id.
 550  *
 551  * @param mq message queue, id will be unique for the queue
 552  * @param assoc_data to associate
 553  */
 554 uint32_t
 555 GNUNET_MQ_assoc_add (struct GNUNET_MQ_Handle *mq,
 556                      void *assoc_data);
 557
 558
 559 /**
 560  * Get the data associated with a @a request_id in a queue
 561  *
 562  * @param mq the message queue with the association
 563  * @param request_id the request id we are interested in
 564  * @return the associated data
 565  */
 566 void *
 567 GNUNET_MQ_assoc_get (struct GNUNET_MQ_Handle *mq,
 568                      uint32_t request_id);
 569
 570
 571 /**
 572  * Remove the association for a @a request_id
 573  *
 574  * @param mq the message queue with the association
 575  * @param request_id the request id we want to remove
 576  * @return the associated data
 577  */
 578 void *
 579 GNUNET_MQ_assoc_remove (struct GNUNET_MQ_Handle *mq,
 580                         uint32_t request_id);
 581
 582
 583 /**
 584  * Create a message queue for the specified handlers.
 585  *
 586  * @param send function the implements sending messages
 587  * @param destroy function that implements destroying the queue
 588  * @param cancel function that implements canceling a message
 589  * @param impl_state for the queue, passed to @a send, @a destroy and @a cancel
 590  * @param handlers array of message handlers
 591  * @param error_handler handler for read and write errors
 592  * @param cls closure for message handlers and error handler
 593  * @return a new message queue
 594  */
 595 struct GNUNET_MQ_Handle *
 596 GNUNET_MQ_queue_for_callbacks (GNUNET_MQ_SendImpl send,
 597                                GNUNET_MQ_DestroyImpl destroy,
 598                                GNUNET_MQ_CancelImpl cancel,
 599                                void *impl_state,
 600                                const struct GNUNET_MQ_MessageHandler *handlers,
 601                                GNUNET_MQ_ErrorHandler error_handler,
 602                                void *cls);
 603
 604
 605 /**
 606  * Change the closure argument in all of the `handlers` of the
 607  * @a mq.
 608  *
 609  * @param mq to modify
 610  * @param handlers_cls new closure to use
 611  */
 612 void
 613 GNUNET_MQ_set_handlers_closure (struct GNUNET_MQ_Handle *mq,
 614                                 void *handlers_cls);
 615
 616
 617 /**
 618  * Call a callback once the envelope has been sent, that is,
 619  * sending it can not be canceled anymore.
 620  * There can be only one notify sent callback per envelope.
 621  *
 622  * @param ev message to call the notify callback for
 623  * @param cb the notify callback
 624  * @param cb_cls closure for the callback
 625  */
 626 void
 627 GNUNET_MQ_notify_sent (struct GNUNET_MQ_Envelope *ev,
 628                        GNUNET_SCHEDULER_TaskCallback cb,
 629                        void *cb_cls);
 630
 631
 632 /**
 633  * Destroy the message queue.
 634  *
 635  * @param mq message queue to destroy
 636  */
 637 void
 638 GNUNET_MQ_destroy (struct GNUNET_MQ_Handle *mq);
 639
 640
 641 /**
 642  * Handle we return for callbacks registered to be
 643  * notified when #GNUNET_MQ_destroy() is called on a queue.
 644  */
 645 struct GNUNET_MQ_DestroyNotificationHandle;
 646
 647
 648 /**
 649  * Register function to be called whenever @a mq is being
 650  * destroyed.
 651  *
 652  * @param mq message queue to watch
 653  * @param cb function to call on @a mq destruction
 654  * @param cb_cls closure for @a cb
 655  * @return handle for #GNUNET_MQ_destroy_notify_cancel().
 656  */
 657 struct GNUNET_MQ_DestroyNotificationHandle *
 658 GNUNET_MQ_destroy_notify (struct GNUNET_MQ_Handle *mq,
 659                           GNUNET_SCHEDULER_TaskCallback cb,
 660                           void *cb_cls);
 661
 662 /**
 663  * Cancel registration from #GNUNET_MQ_destroy_notify().
 664  *
 665  * @param dnh handle for registration to cancel
 666  */
 667 void
 668 GNUNET_MQ_destroy_notify_cancel (struct GNUNET_MQ_DestroyNotificationHandle *dnh);
 669
 670
 671 /**
 672  * Call the message message handler that was registered
 673  * for the type of the given message in the given message queue.
 674  *
 675  * This function is indended to be used for the implementation
 676  * of message queues.
 677  *
 678  * @param mq message queue with the handlers
 679  * @param mh message to dispatch
 680  */
 681 void
 682 GNUNET_MQ_inject_message (struct GNUNET_MQ_Handle *mq,
 683                           const struct GNUNET_MessageHeader *mh);
 684
 685
 686 /**
 687  * Call the error handler of a message queue with the given
 688  * error code.  If there is no error handler, log a warning.
 689  *
 690  * This function is intended to be used for the implementation
 691  * of message queues.
 692  *
 693  * @param mq message queue
 694  * @param error the error type
 695  */
 696 void
 697 GNUNET_MQ_inject_error (struct GNUNET_MQ_Handle *mq,
 698                         enum GNUNET_MQ_Error error);
 699
 700
 701 /**
 702  * Call the send implementation for the next queued message, if any.
 703  * Calls the send notification for the current message unless
 704  * #GNUNET_MQ_impl_send_in_flight was called for this envelope.
 705  *
 706  * Only useful for implementing message queues, results in undefined
 707  * behavior if not used carefully.
 708  *
 709  * @param mq message queue to send the next message with
 710  */
 711 void
 712 GNUNET_MQ_impl_send_continue (struct GNUNET_MQ_Handle *mq);
 713
 714
 715 /**
 716  * Call the send notification for the current message, but do not
 717  * try to send the next message until #gnunet_mq_impl_send_continue
 718  * is called.
 719  *
 720  * only useful for implementing message queues, results in undefined
 721  * behavior if not used carefully.
 722  *
 723  * @param mq message queue to send the next message with
 724  */
 725 void
 726 GNUNET_MQ_impl_send_in_flight (struct GNUNET_MQ_Handle *mq);
 727
 728
 729 /**
 730  * Get the implementation state associated with the
 731  * message queue.
 732  *
 733  * While the GNUNET_MQ_Impl* callbacks receive the
 734  * implementation state, continuations that are scheduled
 735  * by the implementation function often only have one closure
 736  * argument, with this function it is possible to get at the
 737  * implementation state when only passing the `struct GNUNET_MQ_Handle`
 738  * as closure.
 739  *
 740  * @param mq message queue with the current message
 741  * @return message to send, never NULL
 742  */
 743 void *
 744 GNUNET_MQ_impl_state (struct GNUNET_MQ_Handle *mq);
 745
 746
 747 /**
 748  * Get the message that should currently be sent.
 749  * Fails if there is no current message.
 750  * Only useful for implementing message queues,
 751  * results in undefined behavior if not used carefully.
 752  *
 753  * @param mq message queue with the current message
 754  * @return message to send, never NULL
 755  */
 756 const struct GNUNET_MessageHeader *
 757 GNUNET_MQ_impl_current (struct GNUNET_MQ_Handle *mq);
 758
 759
 760 #endif
 761
 762 /** @} */ /* end of group mq */