-typedef int (*gras_cb_t)(gras_socket_t expeditor,
- void *payload);
-void gras_cb_register (gras_msgtype_t msgtype,
- gras_cb_t cb);
-void gras_cb_unregister(gras_msgtype_t msgtype,
- gras_cb_t cb);
-
-xbt_error_t gras_msg_send(gras_socket_t sock,
- gras_msgtype_t msgtype,
- void *payload);
-xbt_error_t gras_msg_wait(double timeout,
- gras_msgtype_t msgt_want,
- gras_socket_t *expeditor,
- void *payload);
-xbt_error_t gras_msg_handle(double timeOut);
-
-
-END_DECL
+
+ /** \brief Type of message callback functions.
+ *
+ * \param expeditor: a socket to contact who sent this message
+ * \param payload: the message itself
+ *
+ * \return true if the message was consumed by the callback,
+ * false if the message was refused by the callback (and should be
+ * passed to the next callback of the stack for this message)
+ *
+ * Once a such a function is registered to handle messages of a given
+ * type with \ref gras_cb_register(), it will be called each time such
+ * a message arrives (unless a gras_msg_wait() intercepts it on arrival).
+ *
+ * If the callback accepts the message, it should free it after use.
+ */
+ typedef int (*gras_msg_cb_t)(gras_socket_t expeditor,
+ void *payload);
+
+ 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);
+
+/** @} */
+/** @name 3. Message exchange */
+/** @{ */
+
+ xbt_error_t gras_msg_send(gras_socket_t sock,
+ gras_msgtype_t msgtype,
+ void *payload);
+ xbt_error_t gras_msg_wait(double timeout,
+ gras_msgtype_t msgt_want,
+ gras_socket_t *expeditor,
+ void *payload);
+ xbt_error_t gras_msg_handle(double timeOut);
+
+/* @} */
+
+END_DECL()