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 SG_BEGIN_DECL()
  19
  20 /** @addtogroup GRAS_msg
  21  *  @brief Defining messages and callbacks, and exchanging messages
  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 to
  32  *  it. If it arrives when before or after \ref 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. The archive
  36  *  contains much more examples, but their are not properly integrated into
  37  *  this documentation yet.
  38  */
  39
  40 /** @defgroup GRAS_msg_decl Message declaration and retrival
  41  *  @ingroup  GRAS_msg
  42  *
  43  *  GRAS messages can only accept one type of payload. See \ref GRAS_dd for
  44  *  more information on how to describe data in GRAS.
  45  *
  46  *  If you absolutely want use a message able to convey several datatypes,
  47  *  you can always say that it conveys a generic reference (see
  48  *  \ref gras_datadesc_ref_generic).
  49  *
  50  *  In order to ease the upgrade of GRAS applications, it is possible to \e
  51  *  version the messages, ie to add a version number to the message (by
  52  *  default, the version is set to 0). Any messages of the wrong version will
  53  *  be ignored by the applications not providing any specific callback for
  54  *  them.
  55  *
  56  *  This mechanism (stolen from the dynamic loader one) should ensure you to
  57  *  change the semantic of a given message while still understanding the old
  58  *  one.
  59  */
  60 /** @{ */
  61 /** \brief Opaque type */
  62 typedef struct s_gras_msgtype *gras_msgtype_t;
  63
  64   XBT_PUBLIC(void) gras_msgtype_declare  (const char           *name,
  65                               gras_datadesc_type_t  payload);
  66   XBT_PUBLIC(void) gras_msgtype_declare_v(const char           *name,
  67                               short int             version,
  68                               gras_datadesc_type_t  payload);
  69
  70   XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_name (const char *name);
  71   XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_name_or_null (const char *name);
  72   XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_namev(const char *name, short int version);
  73   XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_id(int id);
  74
  75   XBT_PUBLIC(void) gras_msgtype_dumpall(void);
  76
  77
  78 /** @} */
  79 /** @defgroup GRAS_msg_cb Callback declaration and use
  80  *  @ingroup  GRAS_msg
  81  *
  82  *
  83  * This is how to register a given function so that it gets called when a
  84  * given type of message arrives.
  85  *
  86  * You can register several callbacks to the same kind of messages, and
  87  * they will get stacked. The lastly added callback gets the message first.
  88  * If it consumes the message, it should return a true value when done. If
  89  * not, it should return 0, and the message will be passed to the second
  90  * callback of the stack, if any.
  91  *
  92  * @{
  93  */
  94
  95   /** \brief Context of callbacks (opaque structure, created by the middleware only, never by user) */
  96   typedef struct s_gras_msg_cb_ctx *gras_msg_cb_ctx_t;
  97
  98 XBT_PUBLIC(void) gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx) ;
  99 XBT_PUBLIC(gras_socket_t) gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx);
 100
 101   /** \brief Type of message callback functions.
 102    *
 103    * \param expeditor: a socket to contact who sent this message
 104    * \param payload: the message itself
 105    *
 106    * \return true if the message was consumed by the callback,
 107    *  false if the message was refused by the callback (and should be
 108    *  passed to the next callback of the stack for this message)
 109    *
 110    * Once a such a function is registered to handle messages of a given
 111    * type with \ref gras_cb_register(), it will be called each time such
 112    * a message arrives (unless a gras_msg_wait() intercepts it on arrival).
 113    *
 114    * If the callback accepts the message, it should free it after use.
 115    */
 116   typedef int (*gras_msg_cb_t)(gras_msg_cb_ctx_t  ctx,
 117                                void             *payload);
 118
 119  /**
 120   * @brief Bind the given callback to the given message type (described by its name)
 121   * @hideinitializer
 122   *
 123   * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
 124   * if it returns a non-null value, the message will be passed to the second one.
 125   * And so on until one of the callbacks accepts the message.
 126   *
 127   * Using gras_cb_register is a bit slower than using gras_cb_register_ since GRAS
 128   * has to search for the given msgtype in the hash table, but you don't care in most case.
 129   */
 130 #define gras_cb_register(msgtype_name, cb)   gras_cb_register_(gras_msgtype_by_name(msgtype_name),cb)
 131
 132  /**
 133   * @brief Unbind the given callback to the given message type (described by its name)
 134   * @hideinitializer
 135   *
 136   * Using gras_cb_unregister is a bit slower than using gras_cb_unregister_ since GRAS
 137   * has to search for the given msgtype in the hash table, but you don't care in most case.
 138   */
 139 #define gras_cb_unregister(msgtype_name, cb) gras_cb_unregister_(gras_msgtype_by_name(msgtype_name),cb)
 140
 141   XBT_PUBLIC(void) gras_cb_register_  (gras_msgtype_t msgtype, gras_msg_cb_t cb);
 142   XBT_PUBLIC(void) gras_cb_unregister_(gras_msgtype_t msgtype, gras_msg_cb_t cb);
 143
 144 /** @} */
 145
 146 /** @defgroup GRAS_msg_exchange Message exchange
 147  *  @ingroup  GRAS_msg
 148  *
 149  */
 150 /** @{ */
 151
 152
 153   XBT_PUBLIC(void) gras_msg_send(gras_socket_t   sock,
 154                      gras_msgtype_t  msgtype,
 155                      void           *payload);
 156   XBT_PUBLIC(void) gras_msg_wait(double          timeout,
 157                      gras_msgtype_t  msgt_want,
 158                      gras_socket_t  *expeditor,
 159                      void           *payload);
 160   XBT_PUBLIC(void) gras_msg_handleall(double period);
 161   XBT_PUBLIC(void) gras_msg_handle(double timeOut);
 162
 163 /** @} */
 164
 165 /** @defgroup GRAS_msg_rpc RPC specific functions
 166  *  @ingroup  GRAS_msg
 167  *
 168  * Remote Procedure Call (RPC) are a classical mecanism to request a service
 169  * from a remote host. Using this set of functions, you let GRAS doing most of
 170  * the work of sending the request, wait for an answer, make sure it is the
 171  * right answer from the right host and so on.  Any exception raised on the
 172  * server is also passed over the network to the client.
 173  *
 174  * Callbacks are attached to RPC incomming messages the regular way using
 175  * \ref gras_cb_register.
 176  *
 177  * For an example of use, check the examples/gras/rpc directory of the distribution.
 178  */
 179 /** @{ */
 180
 181 /* declaration */
 182 XBT_PUBLIC(void) gras_msgtype_declare_rpc(const char           *name,
 183                               gras_datadesc_type_t  payload_request,
 184                               gras_datadesc_type_t  payload_answer);
 185
 186 XBT_PUBLIC(void) gras_msgtype_declare_rpc_v(const char           *name,
 187                                 short int             version,
 188                                 gras_datadesc_type_t  payload_request,
 189                                 gras_datadesc_type_t  payload_answer);
 190
 191 /* client side */
 192 XBT_PUBLIC(void) gras_msg_rpccall(gras_socket_t server,
 193                       double timeOut,
 194                       gras_msgtype_t msgtype,
 195                       void *request, void *answer);
 196 XBT_PUBLIC(gras_msg_cb_ctx_t)
 197 gras_msg_rpc_async_call(gras_socket_t server,
 198                         double timeOut,
 199                         gras_msgtype_t msgtype,
 200                         void *request);
 201 XBT_PUBLIC(void) gras_msg_rpc_async_wait(gras_msg_cb_ctx_t ctx,
 202                              void *answer);
 203
 204 /* server side */
 205 XBT_PUBLIC(void) gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx,void *answer);
 206
 207
 208 /** @} */
 209
 210 /** @defgroup GRAS_msg_exchangeadv Message exchange (advanced interface)
 211  *  @ingroup  GRAS_msg
 212  *
 213  */
 214 /** @{ */
 215
 216 /** @brief Message kind (internal enum) */
 217 typedef enum {
 218   e_gras_msg_kind_unknown = 0,
 219
 220   e_gras_msg_kind_oneway=1,    /**< good old regular messages */
 221
 222   e_gras_msg_kind_rpccall=2,   /**< RPC request */
 223   /* HACK: e_gras_msg_kind_rpccall also designate RPC message *type* in
 224      msgtype_t, not only in msg_t*/
 225   e_gras_msg_kind_rpcanswer=3, /**< RPC successful answer */
 226   e_gras_msg_kind_rpcerror=4,  /**< RPC failure on server (payload=exception); should not leak to user-space */
 227
 228    /* future:
 229        call cancel, and others
 230      even after:
 231        forwarding request and other application level routing stuff
 232        group communication
 233   */
 234
 235   e_gras_msg_kind_count=5 /* sentinel, dont mess with */
 236 } e_gras_msg_kind_t;
 237
 238
 239 /** @brief Message instance (internal struct) */
 240 typedef struct {
 241     gras_socket_t   expe;
 242   e_gras_msg_kind_t kind;
 243     gras_msgtype_t  type;
 244     unsigned long int ID;
 245     void           *payl;
 246     int             payl_size;
 247 } s_gras_msg_t, *gras_msg_t;
 248
 249 typedef int (*gras_msg_filter_t)(gras_msg_t msg,void *ctx);
 250
 251 XBT_PUBLIC(void) gras_msg_wait_ext(double           timeout,
 252                        gras_msgtype_t   msgt_want,
 253                        gras_socket_t    expe_want,
 254                        gras_msg_filter_t filter,
 255                        void             *filter_ctx,
 256                        gras_msg_t       msg_got);
 257
 258 XBT_PUBLIC(void) gras_msg_wait_or(double         timeout,
 259                       xbt_dynar_t    msgt_want,
 260                       gras_msg_cb_ctx_t *ctx,
 261                       int           *msgt_got,
 262                       void          *payload);
 263
 264
 265 /* @} */
 266
 267 SG_END_DECL()
 268
 269 #endif /* GRAS_MSG_H */
 270