3 /* messaging - high level communication (send/receive messages) */
4 /* module's public interface exported to end user. */
6 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
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. */
11 #ifndef GRAS_MESSAGES_H
12 #define GRAS_MESSAGES_H
15 #include "gras/transport.h"
16 #include "gras/datadesc.h"
20 /** @addtogroup GRAS_msg
21 * @brief Defining messages and callbacks, and exchanging messages (Communication facility)
23 * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref GRAS_API]
24 * <tr><td><b>Prev</b> <td> [\ref GRAS_sock]
25 * <tr><td><b>Next</b> <td> [\ref GRAS_timer]
26 * <tr><td><b>Down</b> <td> [\ref GRAS_msg_decl] </table></center>
28 * There is two way to receive messages in GRAS. The first one is to
29 * register a given function as callback to a given type of messages (see
30 * \ref gras_cb_register and associated section). But you can also
31 * explicitely wait for a given message with the \ref gras_msg_wait
34 * Usually, both ways are not intended to be mixed of a given type of
35 * messages. But if you do so, it shouldn't trigger any issue. If the
36 * message arrives when gras_msg_wait is blocked, then it will be routed
37 * to it. If it arrives when before or after gras_msg_wait, it will be
38 * passed to the callback.
40 * For an example of use, please refer to \ref GRAS_ex_ping.
45 /** @defgroup GRAS_msg_decl Message declaration and retrival
47 * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref GRAS_API]::[\ref GRAS_msg]
49 * <tr><td><b>Next</b> <td> [\ref GRAS_msg_cb] </table></center>
51 * GRAS messages can only accept one type of payload. If you absolutely want to declare a message
52 * able to convey several datatypes, you can always say that it conveys a generic reference (see
53 * \ref gras_datadesc_ref_generic).
55 * In order to ease the upgrade of GRAS applications, it is possible to \e version the messages, ie
56 * to add a version number to the message (by default, the version is set to 0). Any messages of the
57 * wrong version will be ignored by the applications not providing any specific callback for them.
59 * This mechanism (stolen from the dynamic loader one) should ensure you to change the semantic of a given
60 * message while still understanding the old one.
63 /** \brief Opaque type */
64 typedef struct s_gras_msgtype *gras_msgtype_t;
66 void gras_msgtype_declare (const char *name,
67 gras_datadesc_type_t payload);
68 void gras_msgtype_declare_v(const char *name,
70 gras_datadesc_type_t payload);
72 gras_msgtype_t gras_msgtype_by_name (const char *name);
73 gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version);
74 gras_msgtype_t gras_msgtype_by_id(int id);
77 /** @defgroup GRAS_msg_cb Callback declaration and use
79 * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref GRAS_API]::[\ref GRAS_msg]
80 * <tr><td><b>Prev</b> <td> [\ref GRAS_msg_decl]
81 * <tr><td><b>Next</b> <td> [\ref GRAS_msg_exchange] </table></center>
83 * This is how to register a given function so that it gets called when a
84 * given type of message arrives.
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.
95 /** \brief Type of message callback functions.
97 * \param expeditor: a socket to contact who sent this message
98 * \param payload: the message itself
100 * \return true if the message was consumed by the callback,
101 * false if the message was refused by the callback (and should be
102 * passed to the next callback of the stack for this message)
104 * Once a such a function is registered to handle messages of a given
105 * type with \ref gras_cb_register(), it will be called each time such
106 * a message arrives (unless a gras_msg_wait() intercepts it on arrival).
108 * If the callback accepts the message, it should free it after use.
110 typedef int (*gras_msg_cb_t)(gras_socket_t expeditor,
113 void gras_cb_register (gras_msgtype_t msgtype, gras_msg_cb_t cb);
114 void gras_cb_unregister(gras_msgtype_t msgtype, gras_msg_cb_t cb);
117 /** @defgroup GRAS_msg_exchange Message exchange
119 * <center><table><tr><td><b>Top</b> <td> [\ref index]::[\ref GRAS_API]::[\ref GRAS_msg]
120 * <tr><td><b>Prev</b> <td> [\ref GRAS_msg_cb]
121 * <tr><td> Next <td> </table></center>
125 void gras_msg_send(gras_socket_t sock,
126 gras_msgtype_t msgtype,
128 void gras_msg_wait(double timeout,
129 gras_msgtype_t msgt_want,
130 gras_socket_t *expeditor,
132 void gras_msg_handle(double timeOut);
139 #endif /* GRAS_MSG_H */