include/gras/messages.h

   1 /* $Id$ */
   2
   3 /* messaging - high level communication (send/receive messages)             */
   4 /* module's public interface exported to end user.                          */
   5
   6 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef GRAS_MESSAGES_H
  12 #define GRAS_MESSAGES_H
  13
  14 #include "xbt/misc.h"
  15 #include "gras/transport.h"
  16 #include "gras/datadesc.h"
  17
  18 BEGIN_DECL()
  19
  20 /** @addtogroup GRAS_msg
  21  *  @brief Defining messages and callbacks, and exchanging messages (Communication facility)
  22  *
  23  *  There is two way to receive messages in GRAS. The first one is to
  24  *  register a given function as callback to a given type of messages (see
  25  *  \ref gras_cb_register and associated section). But you can also
  26  *  explicitely wait for a given message with the \ref gras_msg_wait
  27  *  function.
  28  *
  29  *  Usually, both ways are not intended to be mixed of a given type of
  30  *  messages. But if you do so, it shouldn't trigger any issue.  If the
  31  *  message arrives when gras_msg_wait is blocked, then it will be routed
  32  *  to it. If it arrives when before or after gras_msg_wait, it will be
  33  *  passed to the callback.
  34  *
  35  *  For an example of use, please refer to \ref GRAS_ex_ping.
  36  *
  37  *  @{
  38  */
  39
  40 /** @name 1. Message declaration and retrival
  41  *
  42  *  GRAS messages can only accept one type of payload. If you absolutely want to declare a message
  43  *  able to convey several datatypes, you can always say that it conveys a generic reference (see
  44  *  \ref gras_datadesc_ref_generic).
  45  *
  46  *  In order to ease the upgrade of GRAS applications, it is possible to \e version the messages, ie
  47  *  to add a version number to the message (by default, the version is set to 0). Any messages of the
  48  *  wrong version will be ignored by the applications not providing any specific callback for them.
  49  *
  50  *  This mechanism (stolen from the dynamic loader one) should ensure you to change the semantic of a given
  51  *  message while still understanding the old one.
  52  */
  53 /** @{ */
  54 /** \brief Opaque type */
  55 typedef struct s_gras_msgtype *gras_msgtype_t;
  56
  57   void gras_msgtype_declare  (const char           *name,
  58                               gras_datadesc_type_t  payload);
  59   void gras_msgtype_declare_v(const char           *name,
  60                               short int             version,
  61                               gras_datadesc_type_t  payload);
  62
  63   gras_msgtype_t gras_msgtype_by_name (const char *name);
  64   gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version);
  65   gras_msgtype_t gras_msgtype_by_id(int id);
  66
  67 /** @} */
  68 /** @name 2. Callback declaration and use
  69  *
  70  * This is how to register a given function so that it gets called when a
  71  * given type of message arrives.
  72  *
  73  * You can register several callbacks to the same kind of messages, and
  74  * they will get stacked. The lastly added callback gets the message first.
  75  * If it consumes the message, it should return a true value when done. If
  76  * not, it should return 0, and the message will be passed to the second
  77  * callback of the stack, if any.
  78  *
  79  * @{
  80  */
  81
  82   /** \brief Type of message callback functions.
  83    *
  84    * \param expeditor: a socket to contact who sent this message
  85    * \param payload: the message itself
  86    *
  87    * \return true if the message was consumed by the callback,
  88    *  false if the message was refused by the callback (and should be
  89    *  passed to the next callback of the stack for this message)
  90    *
  91    * Once a such a function is registered to handle messages of a given
  92    * type with \ref gras_cb_register(), it will be called each time such
  93    * a message arrives (unless a gras_msg_wait() intercepts it on arrival).
  94    *
  95    * If the callback accepts the message, it should free it after use.
  96    */
  97   typedef int (*gras_msg_cb_t)(gras_socket_t  expeditor,
  98                                void          *payload);
  99
 100   void gras_cb_register  (gras_msgtype_t msgtype, gras_msg_cb_t cb);
 101   void gras_cb_unregister(gras_msgtype_t msgtype, gras_msg_cb_t cb);
 102
 103 /** @} */
 104 /** @name 3. Message exchange */
 105 /** @{ */
 106
 107   void gras_msg_send(gras_socket_t   sock,
 108                      gras_msgtype_t  msgtype,
 109                      void           *payload);
 110   void gras_msg_wait(double          timeout,
 111                      gras_msgtype_t  msgt_want,
 112                      gras_socket_t  *expeditor,
 113                      void           *payload);
 114   void gras_msg_handle(double timeOut);
 115
 116 /* @} */
 117
 118 END_DECL()
 119
 120 #endif /* GRAS_MSG_H */
 121