X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/dff9e15c44ab6340d27215957c56fa72fad246a2..e2f62fd18beb9867571a81984aa9a26b4e9f48d4:/include/gras/messages.h diff --git a/include/gras/messages.h b/include/gras/messages.h index e7485157ca..d2595c5460 100644 --- a/include/gras/messages.h +++ b/include/gras/messages.h @@ -1,9 +1,8 @@ -/* $Id$ */ - /* messaging - high level communication (send/receive messages) */ /* module's public interface exported to end user. */ -/* Copyright (c) 2003-2007 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. */ @@ -11,9 +10,9 @@ #ifndef GRAS_MESSAGES_H #define GRAS_MESSAGES_H -#include "xbt/misc.h" #include "gras/transport.h" -#include "gras/datadesc.h" +#include "xbt/datadesc.h" +#include "xbt/socket.h" SG_BEGIN_DECL() @@ -44,7 +43,7 @@ SG_BEGIN_DECL() * * If you absolutely want use a message able to convey several datatypes, * you can always say that it conveys a generic reference (see - * \ref gras_datadesc_ref_generic). + * \ref xbt_datadesc_ref_generic). * * In order to ease the upgrade of GRAS applications, it is possible to \e * version the messages, ie to add a version number to the message (by @@ -58,19 +57,20 @@ SG_BEGIN_DECL() */ /** @{ */ /** \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_datadesc_type_t payload); XBT_PUBLIC(void) gras_msgtype_declare_v(const char *name, short int version, - gras_datadesc_type_t payload); + xbt_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); XBT_PUBLIC(void) gras_msgtype_dumpall(void); @@ -93,10 +93,10 @@ XBT_PUBLIC(void) gras_msgtype_dumpall(void); */ /** \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; +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); +XBT_PUBLIC(xbt_socket_t) gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx); /** \brief Type of message callback functions. * @@ -113,7 +113,7 @@ XBT_PUBLIC(gras_socket_t) gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx); * * 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) @@ -137,7 +137,8 @@ XBT_PUBLIC(gras_socket_t) gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx); */ #define gras_cb_unregister(msgtype_name, cb) gras_cb_unregister_(gras_msgtype_by_name(msgtype_name),cb) -XBT_PUBLIC(void) gras_cb_register_(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); @@ -156,7 +157,7 @@ XBT_PUBLIC(void) gras_cb_unregister_(gras_msgtype_t msgtype, * 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, +XBT_PUBLIC(void) gras_msg_send_(xbt_socket_t sock, gras_msgtype_t msgtype, void *payload); /** \brief Waits for a message to come in over a given socket @@ -177,7 +178,7 @@ XBT_PUBLIC(void) gras_msg_send_(gras_socket_t sock, #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_socket_t * expeditor, void *payload); XBT_PUBLIC(void) gras_msg_handleall(double period); XBT_PUBLIC(void) gras_msg_handle(double timeOut); @@ -201,16 +202,16 @@ XBT_PUBLIC(void) gras_msg_handle(double timeOut); /* declaration */ XBT_PUBLIC(void) gras_msgtype_declare_rpc(const char *name, - gras_datadesc_type_t + xbt_datadesc_type_t payload_request, - gras_datadesc_type_t + xbt_datadesc_type_t payload_answer); XBT_PUBLIC(void) gras_msgtype_declare_rpc_v(const char *name, short int version, - gras_datadesc_type_t + xbt_datadesc_type_t payload_request, - gras_datadesc_type_t + xbt_datadesc_type_t payload_answer); /* client side */ @@ -219,7 +220,7 @@ XBT_PUBLIC(void) gras_msgtype_declare_rpc_v(const char *name, * @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, +XBT_PUBLIC(void) gras_msg_rpccall_(xbt_socket_t server, double timeOut, gras_msgtype_t msgtype, void *request, void *answer); @@ -229,10 +230,11 @@ XBT_PUBLIC(gras_msg_cb_ctx_t) * @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, + gras_msg_rpc_async_call_(xbt_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); +XBT_PUBLIC(void) gras_msg_rpc_async_wait(gras_msg_cb_ctx_t ctx, + void *answer); /* server side */ XBT_PUBLIC(void) gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx, @@ -248,48 +250,48 @@ XBT_PUBLIC(void) gras_msg_rpcreturn(double timeOut, gras_msg_cb_ctx_t ctx, /** @{ */ /** @brief Message kind (internal enum) */ - typedef enum { - e_gras_msg_kind_unknown = 0, +typedef enum { + e_gras_msg_kind_unknown = 0, - e_gras_msg_kind_oneway = 1, + e_gras_msg_kind_oneway = 1, /**< good old regular messages */ - e_gras_msg_kind_rpccall = 2, + 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, + /* 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, + 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 - */ + /* 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; + 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 struct { + xbt_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); +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, + xbt_socket_t expe_want, gras_msg_filter_t filter, void *filter_ctx, gras_msg_t msg_got); @@ -302,4 +304,4 @@ XBT_PUBLIC(void) gras_msg_wait_or(double timeout, /* @} */ SG_END_DECL() -#endif /* GRAS_MSG_H */ +#endif /* GRAS_MSG_H */