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   void gras_msgtype_declare  (const char           *name,
  65                               gras_datadesc_type_t  payload);
  66   void gras_msgtype_declare_v(const char           *name,
  67                               short int             version,
  68                               gras_datadesc_type_t  payload);
  69
  70   gras_msgtype_t gras_msgtype_by_name (const char *name);
  71   gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version);
  72   gras_msgtype_t gras_msgtype_by_id(int id);
  73
  74 /** @} */
  75 /** @defgroup GRAS_msg_cb Callback declaration and use
  76  *  @ingroup  GRAS_msg
  77  *
  78  *
  79  * This is how to register a given function so that it gets called when a
  80  * given type of message arrives.
  81  *
  82  * You can register several callbacks to the same kind of messages, and
  83  * they will get stacked. The lastly added callback gets the message first.
  84  * If it consumes the message, it should return a true value when done. If
  85  * not, it should return 0, and the message will be passed to the second
  86  * callback of the stack, if any.
  87  *
  88  * @{
  89  */
  90
  91   /** \brief Context of callbacks (opaque structure) */
  92   typedef struct s_gras_msg_cb_ctx *gras_msg_cb_ctx_t;
  93
  94 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx);
  95
  96   /** \brief Type of message callback functions.
  97    *
  98    * \param expeditor: a socket to contact who sent this message
  99    * \param payload: the message itself
 100    *
 101    * \return true if the message was consumed by the callback,
 102    *  false if the message was refused by the callback (and should be
 103    *  passed to the next callback of the stack for this message)
 104    *
 105    * Once a such a function is registered to handle messages of a given
 106    * type with \ref gras_cb_register(), it will be called each time such
 107    * a message arrives (unless a gras_msg_wait() intercepts it on arrival).
 108    *
 109    * If the callback accepts the message, it should free it after use.
 110    */
 111   typedef int (*gras_msg_cb_t)(gras_msg_cb_ctx_t  ctx,
 112                                void             *payload);
 113
 114   void gras_cb_register  (gras_msgtype_t msgtype, gras_msg_cb_t cb);
 115   void gras_cb_unregister(gras_msgtype_t msgtype, gras_msg_cb_t cb);
 116
 117 /** @} */
 118
 119 /** @defgroup GRAS_msg_exchange Message exchange
 120  *  @ingroup  GRAS_msg
 121  *
 122  */
 123 /** @{ */
 124
 125
 126   void gras_msg_send(gras_socket_t   sock,
 127                      gras_msgtype_t  msgtype,
 128                      void           *payload);
 129   void gras_msg_wait(double          timeout,
 130                      gras_msgtype_t  msgt_want,
 131                      gras_socket_t  *expeditor,
 132                      void           *payload);
 133   void gras_msg_handle(double timeOut);
 134
 135 /** @} */
 136
 137 /** @defgroup GRAS_msg_rpc RPC specific functions
 138  *  @ingroup  GRAS_msg
 139  *
 140  * Remote Procedure Call (RPC) are a classical mecanism to request a service
 141  * from a remote host. Using this set of functions, you let GRAS doing most of
 142  * the work of sending the request, wait for an answer, make sure it is the
 143  * right answer from the right host and so on.  Any exception raised on the
 144  * server is also passed over the network to the client.
 145  *
 146  * Callbacks are attached to RPC incomming messages the regular way using
 147  * \ref gras_cb_register.
 148  *
 149  * For an example of use, check the examples/gras/rpc directory of the distribution.
 150  */
 151 /** @{ */
 152
 153 /* declaration */
 154 void gras_msgtype_declare_rpc(const char           *name,
 155                               gras_datadesc_type_t  payload_request,
 156                               gras_datadesc_type_t  payload_answer);
 157
 158 void gras_msgtype_declare_rpc_v(const char           *name,
 159                                 short int             version,
 160                                 gras_datadesc_type_t  payload_request,
 161                                 gras_datadesc_type_t  payload_answer);
 162
 163 /* client side */
 164 void gras_msg_rpccall(gras_socket_t server,
 165                       double timeOut,
 166                       gras_msgtype_t msgtype,
 167                       void *request, void *answer);
 168 gras_msg_cb_ctx_t
 169 gras_msg_rpc_async_call(gras_socket_t server,
 170                         double timeOut,
 171                         gras_msgtype_t msgtype,
 172                         void *request);
 173 void gras_msg_rpc_async_wait(gras_msg_cb_ctx_t ctx,
 174                              void *answer);
 175
 176 /* server side */
 177 void gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx,void *answer);
 178
 179
 180 /** @} */
 181
 182 /** @defgroup GRAS_msg_exchangeadv Message exchange (advanced interface)
 183  *  @ingroup  GRAS_msg
 184  *
 185  */
 186 /** @{ */
 187
 188 /** @brief Message kind (internal enum) */
 189 typedef enum {
 190   e_gras_msg_kind_unknown = 0,
 191
 192   e_gras_msg_kind_oneway=1,    /**< good old regular messages */
 193
 194   e_gras_msg_kind_rpccall=2,   /**< RPC request */
 195   /* HACK: e_gras_msg_kind_rpccall also designate RPC message *type* in
 196      msgtype_t, not only in msg_t*/
 197   e_gras_msg_kind_rpcanswer=3, /**< RPC successful answer */
 198   e_gras_msg_kind_rpcerror=4,  /**< RPC failure on server (payload=exception); should not leak to user-space */
 199
 200    /* future:
 201        call cancel, and others
 202      even after:
 203        forwarding request and other application level routing stuff
 204        group communication
 205   */
 206
 207   e_gras_msg_kind_count=5 /* sentinel, dont mess with */
 208 } e_gras_msg_kind_t;
 209
 210
 211 /** @brief Message instance (internal struct) */
 212 typedef struct {
 213     gras_socket_t   expe;
 214   e_gras_msg_kind_t kind;
 215     gras_msgtype_t  type;
 216     unsigned long int ID;
 217     void           *payl;
 218     int             payl_size;
 219 } s_gras_msg_t, *gras_msg_t;
 220
 221 typedef int (*gras_msg_filter_t)(gras_msg_t msg,void *ctx);
 222
 223   void gras_msg_wait_ext(double           timeout,
 224                          gras_msgtype_t   msgt_want,
 225                          gras_socket_t    expe_want,
 226                          gras_msg_filter_t filter,
 227                          void             *filter_ctx,
 228                          gras_msg_t       msg_got);
 229
 230
 231 /* @} */
 232
 233 SG_END_DECL()
 234
 235 #endif /* GRAS_MSG_H */
 236