-/* $Id$ */
-
/* messaging - high level communication (send/receive messages) */
/* module's public interface exported to end user. */
-/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
* contains much more examples, but their are not properly integrated into
* this documentation yet.
*/
-
/** @defgroup GRAS_msg_decl Message declaration and retrival
* @ingroup GRAS_msg
*
* change the semantic of a given message while still understanding the old
* one.
*/
-/** @{ */
+/** @{ */
/** \brief Opaque type */
-typedef struct s_gras_msgtype *gras_msgtype_t;
+ typedef struct s_gras_msgtype *gras_msgtype_t;
+
+XBT_PUBLIC(void) gras_msgtype_declare(const char *name,
+ gras_datadesc_type_t payload);
+XBT_PUBLIC(void) gras_msgtype_declare_v(const char *name,
+ short int version,
+ gras_datadesc_type_t payload);
- void gras_msgtype_declare (const char *name,
- gras_datadesc_type_t payload);
- void gras_msgtype_declare_v(const char *name,
- short int version,
- gras_datadesc_type_t payload);
+XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_name(const char *name);
+XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_name_or_null(const char *name);
+XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_namev(const char *name,
+ short int version);
+XBT_PUBLIC(gras_msgtype_t) gras_msgtype_by_id(int id);
+XBT_PUBLIC(const char*) gras_msgtype_get_name(gras_msgtype_t type);
- gras_msgtype_t gras_msgtype_by_name (const char *name);
- gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version);
- gras_msgtype_t gras_msgtype_by_id(int id);
+XBT_PUBLIC(void) gras_msgtype_dumpall(void);
-/** @} */
+
+/** @} */
/** @defgroup GRAS_msg_cb Callback declaration and use
* @ingroup GRAS_msg
*
*
* @{
*/
-
- /** \brief Context of callbacks (opaque structure) */
- typedef struct s_gras_msg_cb_ctx *gras_msg_cb_ctx_t;
-
-gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx);
-gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
- gras_msgtype_t msgtype,
- unsigned long int ID,
- double timeout);
-void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx) ;
-
-
+
+ /** \brief Context of callbacks (opaque structure, created by the middleware only, never by user) */
+ typedef struct s_gras_msg_cb_ctx *gras_msg_cb_ctx_t;
+
+XBT_PUBLIC(void) gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx);
+XBT_PUBLIC(gras_socket_t) gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx);
+
/** \brief Type of message callback functions.
*
* \param expeditor: a socket to contact who sent this message
*
* If the callback accepts the message, it should free it after use.
*/
- typedef int (*gras_msg_cb_t)(gras_msg_cb_ctx_t ctx,
- void *payload);
+ typedef int (*gras_msg_cb_t) (gras_msg_cb_ctx_t ctx, void *payload);
+
+ /**
+ * @brief Bind the given callback to the given message type (described by its name)
+ * @hideinitializer
+ *
+ * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
+ * if it returns a non-null value, the message will be passed to the second one.
+ * And so on until one of the callbacks accepts the message.
+ *
+ * Using gras_cb_register is a bit slower than using gras_cb_register_ since GRAS
+ * has to search for the given msgtype in the hash table, but you don't care in most case.
+ */
+#define gras_cb_register(msgtype_name, cb) gras_cb_register_(gras_msgtype_by_name(msgtype_name),cb)
+
+ /**
+ * @brief Unbind the given callback to the given message type (described by its name)
+ * @hideinitializer
+ *
+ * Using gras_cb_unregister is a bit slower than using gras_cb_unregister_ since GRAS
+ * has to search for the given msgtype in the hash table, but you don't care in most case.
+ */
+#define gras_cb_unregister(msgtype_name, cb) gras_cb_unregister_(gras_msgtype_by_name(msgtype_name),cb)
- void gras_cb_register (gras_msgtype_t msgtype, gras_msg_cb_t cb);
- void gras_cb_unregister(gras_msgtype_t msgtype, gras_msg_cb_t cb);
+XBT_PUBLIC(void) gras_cb_register_(gras_msgtype_t msgtype, gras_msg_cb_t cb);
+XBT_PUBLIC(void) gras_cb_unregister_(gras_msgtype_t msgtype,
+ gras_msg_cb_t cb);
-/** @} */
+/** @} */
/** @defgroup GRAS_msg_exchange Message exchange
* @ingroup GRAS_msg
*/
/** @{ */
+/** \brief Send the data pointed by \a payload as a message \a msgname on the \a sock
+ * @hideinitializer
+ *
+ * Using gras_msg_wait() is a bit slower than using gras_msg_wait_() since GRAS
+ * has to search for the given msgtype in the hash table.
+ */
+#define gras_msg_send(sock,name,payload) gras_msg_send_(sock,gras_msgtype_by_name(name),payload)
+XBT_PUBLIC(void) gras_msg_send_(gras_socket_t sock,
+ gras_msgtype_t msgtype, void *payload);
+
+/** \brief Waits for a message to come in over a given socket
+ * @hideinitializer
+ * @param timeout: How long should we wait for this message.
+ * @param msgt_want: type of awaited msg
+ * @param[out] expeditor: where to create a socket to answer the incomming message
+ * @param[out] payload: where to write the payload of the incomming message
+ * @return the error code (or no_error).
+ *
+ * Every message of another type received before the one waited will be queued
+ * and used by subsequent call to this function or gras_msg_handle().
+ *
+ * Using gras_msg_wait() is a bit slower than using gras_msg_wait_() since GRAS
+ * has to search for the given msgtype in the hash table.
+ */
- void gras_msg_send(gras_socket_t sock,
- gras_msgtype_t msgtype,
- void *payload);
- void gras_msg_wait(double timeout,
- gras_msgtype_t msgt_want,
- gras_socket_t *expeditor,
- void *payload);
- void gras_msg_handleall(double period);
- void gras_msg_handle(double timeOut);
+#define gras_msg_wait(timeout,msgt_want,expeditor,payload) gras_msg_wait_(timeout,gras_msgtype_by_name(msgt_want),expeditor,payload)
+XBT_PUBLIC(void) gras_msg_wait_(double timeout,
+ gras_msgtype_t msgt_want,
+ gras_socket_t * expeditor, void *payload);
+XBT_PUBLIC(void) gras_msg_handleall(double period);
+XBT_PUBLIC(void) gras_msg_handle(double timeOut);
/** @} */
/** @{ */
/* declaration */
-void gras_msgtype_declare_rpc(const char *name,
- gras_datadesc_type_t payload_request,
- gras_datadesc_type_t payload_answer);
-
-void gras_msgtype_declare_rpc_v(const char *name,
- short int version,
- gras_datadesc_type_t payload_request,
- gras_datadesc_type_t payload_answer);
+XBT_PUBLIC(void) gras_msgtype_declare_rpc(const char *name,
+ gras_datadesc_type_t
+ payload_request,
+ gras_datadesc_type_t
+ payload_answer);
+
+XBT_PUBLIC(void) gras_msgtype_declare_rpc_v(const char *name,
+ short int version,
+ gras_datadesc_type_t
+ payload_request,
+ gras_datadesc_type_t
+ payload_answer);
/* client side */
-void gras_msg_rpccall(gras_socket_t server,
- double timeOut,
- gras_msgtype_t msgtype,
- void *request, void *answer);
-gras_msg_cb_ctx_t
-gras_msg_rpc_async_call(gras_socket_t server,
- double timeOut,
- gras_msgtype_t msgtype,
- void *request);
-void gras_msg_rpc_async_wait(gras_msg_cb_ctx_t ctx,
- void *answer);
+
+/** @brief Conduct a RPC call
+ * @hideinitializer
+ */
+#define gras_msg_rpccall(server,timeout,msg,req,ans) gras_msg_rpccall_(server,timeout,gras_msgtype_by_name(msg),req,ans)
+XBT_PUBLIC(void) gras_msg_rpccall_(gras_socket_t server,
+ double timeOut,
+ gras_msgtype_t msgtype,
+ void *request, void *answer);
+XBT_PUBLIC(gras_msg_cb_ctx_t)
+
+/** @brief Launch a RPC call, but do not block for the answer
+ * @hideinitializer
+ */
+#define gras_msg_rpc_async_call(server,timeout,msg,req) gras_msg_rpc_async_call_(server,timeout,gras_msgtype_by_name(msg),req)
+ gras_msg_rpc_async_call_(gras_socket_t server,
+ double timeOut,
+ gras_msgtype_t msgtype, void *request);
+XBT_PUBLIC(void) gras_msg_rpc_async_wait(gras_msg_cb_ctx_t ctx, void *answer);
/* server side */
-void gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx,void *answer);
+XBT_PUBLIC(void) gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx,
+ void *answer);
/** @} */
/** @{ */
/** @brief Message kind (internal enum) */
-typedef enum {
- e_gras_msg_kind_unknown = 0,
-
- e_gras_msg_kind_oneway=1, /**< good old regular messages */
-
- e_gras_msg_kind_rpccall=2, /**< RPC request */
- /* HACK: e_gras_msg_kind_rpccall also designate RPC message *type* in
- msgtype_t, not only in msg_t*/
- e_gras_msg_kind_rpcanswer=3, /**< RPC successful answer */
- e_gras_msg_kind_rpcerror=4, /**< RPC failure on server (payload=exception); should not leak to user-space */
-
- /* future:
- call cancel, and others
- even after:
- forwarding request and other application level routing stuff
- group communication
- */
+ typedef enum {
+ e_gras_msg_kind_unknown = 0,
+
+ e_gras_msg_kind_oneway = 1,
+ /**< good old regular messages */
+
+ e_gras_msg_kind_rpccall = 2,
+ /**< RPC request */
+ /* HACK: e_gras_msg_kind_rpccall also designate RPC message *type* in
+ msgtype_t, not only in msg_t */
+ e_gras_msg_kind_rpcanswer = 3,
+ /**< RPC successful answer */
+ e_gras_msg_kind_rpcerror = 4,
+ /**< RPC failure on server (payload=exception); should not leak to user-space */
- e_gras_msg_kind_count=5 /* sentinel, dont mess with */
-} e_gras_msg_kind_t;
+ /* future:
+ call cancel, and others
+ even after:
+ forwarding request and other application level routing stuff
+ group communication
+ */
+
+ e_gras_msg_kind_count = 5 /* sentinel, dont mess with */
+ } e_gras_msg_kind_t;
/** @brief Message instance (internal struct) */
-typedef struct {
- gras_socket_t expe;
- e_gras_msg_kind_t kind;
- gras_msgtype_t type;
- unsigned long int ID;
- void *payl;
- int payl_size;
-} s_gras_msg_t, *gras_msg_t;
-
-typedef int (*gras_msg_filter_t)(gras_msg_t msg,void *ctx);
-
-void gras_msg_wait_ext(double timeout,
- gras_msgtype_t msgt_want,
- gras_socket_t expe_want,
- gras_msg_filter_t filter,
- void *filter_ctx,
- gras_msg_t msg_got);
-
-void gras_msg_wait_or(double timeout,
- xbt_dynar_t msgt_want,
- gras_msg_cb_ctx_t *ctx,
- int *msgt_got,
- void *payload);
+ typedef struct {
+ gras_socket_t expe;
+ e_gras_msg_kind_t kind;
+ gras_msgtype_t type;
+ unsigned long int ID;
+ void *payl;
+ int payl_size;
+ } s_gras_msg_t, *gras_msg_t;
+
+ typedef int (*gras_msg_filter_t) (gras_msg_t msg, void *ctx);
+
+#define gras_msg_wait_ext(timeout, msg, expe, filter, fctx,got) gras_msg_wait_ext_(timeout, gras_msgtype_by_name(msg), expe, filter, fctx,got)
+XBT_PUBLIC(void) gras_msg_wait_ext_(double timeout,
+ gras_msgtype_t msgt_want,
+ gras_socket_t expe_want,
+ gras_msg_filter_t filter,
+ void *filter_ctx, gras_msg_t msg_got);
+
+XBT_PUBLIC(void) gras_msg_wait_or(double timeout,
+ xbt_dynar_t msgt_want,
+ gras_msg_cb_ctx_t * ctx,
+ int *msgt_got, void *payload);
/* @} */
SG_END_DECL()
-
#endif /* GRAS_MSG_H */
-
