X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/eed8daedf7c2d58e0db96826205f138cedb9cc5a..e71309302bbae7b43b0148b327b83bdd8fc8fc0d:/include/gras/transport.h diff --git a/include/gras/transport.h b/include/gras/transport.h index 2d8961ebf7..cdddc2dad5 100644 --- a/include/gras/transport.h +++ b/include/gras/transport.h @@ -1,9 +1,9 @@ -/* $Id$ */ /* transport - low level communication (send/receive bunches of bytes) */ /* module's public interface exported to end user. */ -/* Copyright (c) 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. */ @@ -11,105 +11,56 @@ #ifndef GRAS_TRANSPORT_H #define GRAS_TRANSPORT_H +#include "xbt/socket.h" + /** \addtogroup GRAS_sock - * \brief Socket handling (Communication facility). + * \brief Socket handling * - *
Top [\ref index]::[\ref GRAS_API] - *
Prev [\ref GRAS_dd] - *
Next [\ref GRAS_msg] - *
Down [\ref GRAS_sock_create]
+ * The model of communications in GRAS is very close to the BSD socket one. + * To get two hosts exchanging data, one of them need to open a + * server socket on which it can listen for incoming messages and the + * other one must connect a client socket onto the server one. * - * The model of communications in GRAS is very close to the BSD socket one. To get two hosts - * exchanging data, one of them need to open a server socket on which it can listen for incoming messages - * and the other one must connect a client socket onto the server one. - * - * If you need an example of this, check \ref GRAS_ex_ping. + * The main difference is that you cannot exchange arbitrary bytes on + * sockets, but messages. See the \ref GRAS_msg section for details. + * + * If you need an example of how to use sockets, check \ref GRAS_ex_ping. * */ - + /** \defgroup GRAS_sock_create Socket creation functions * \ingroup GRAS_sock * - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_sock] - *
Prev - *
Next [\ref GRAS_sock_info]
*/ /* @{*/ -/** \brief Opaque type describing a socket */ -typedef struct s_gras_socket *gras_socket_t; /** \brief Simply create a client socket (to speak to a remote host) */ -gras_socket_t gras_socket_client(const char *host, unsigned short port); +XBT_PUBLIC(xbt_socket_t) gras_socket_client(const char *host, + unsigned short port); +XBT_PUBLIC(xbt_socket_t) gras_socket_client_from_string(const char *host); /** \brief Simply create a server socket (to ear from remote hosts speaking to you) */ -gras_socket_t gras_socket_server(unsigned short port); -/** \brief Close socket */ -void gras_socket_close(gras_socket_t sd); +XBT_PUBLIC(xbt_socket_t) gras_socket_server(unsigned short port); +XBT_PUBLIC(void) gras_socket_close(xbt_socket_t sd); +XBT_PUBLIC(void) gras_socket_close_voidp(void *sock); /** \brief Create a client socket, full interface to all relevant settings */ -gras_socket_t gras_socket_client_ext(const char *host, - unsigned short port, - unsigned long int bufSize, - int measurement); +XBT_PUBLIC(xbt_socket_t) gras_socket_client_ext(const char *host, + unsigned short port, + unsigned long int bufSize, + int measurement); /** \brief Create a server socket, full interface to all relevant settings */ -gras_socket_t gras_socket_server_ext(unsigned short port, - unsigned long int bufSize, - int measurement); -/* @}*/ -/** \defgroup GRAS_sock_info Retrieving data about sockets and peers - * \ingroup GRAS_sock - * - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_sock] - *
Prev [\ref GRAS_sock_create] - *
Next [\ref GRAS_sock_meas]
- * - * Who are you talking to? - */ -/* @{*/ +XBT_PUBLIC(xbt_socket_t) gras_socket_server_ext(unsigned short port, + unsigned long int bufSize, + int measurement); +XBT_PUBLIC(xbt_socket_t) + gras_socket_server_range(unsigned short minport, unsigned short maxport, + unsigned long int buf_size, int measurement); -/** Get the port number on which this socket is connected on my side */ -int gras_socket_my_port (gras_socket_t sock); -/** Get the port number on which this socket is connected on remote side */ -int gras_socket_peer_port(gras_socket_t sock); -/** Get the host name of the remote side */ -char *gras_socket_peer_name(gras_socket_t sock); -/* @}*/ - -/** \defgroup GRAS_sock_meas Using measurement sockets - * \ingroup GRAS_sock - * - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_sock] - *
Prev [\ref GRAS_sock_info] - *
Next [\ref GRAS_sock_file]
- * - * You may want to use sockets not to exchange valuable data (in messages), - * but to conduct some bandwidth measurements and related experiments. If so, try those measurement sockets. - * - * You can only use those functions on sockets openned with the "measurement" boolean set to true. - * - */ -/* @{*/ - - - -int gras_socket_is_meas(gras_socket_t sock); -void gras_socket_meas_send(gras_socket_t peer, - unsigned int timeout, - unsigned long int expSize, - unsigned long int msgSize); -void gras_socket_meas_recv(gras_socket_t peer, - unsigned int timeout, - unsigned long int expSize, - unsigned long int msgSize); -gras_socket_t gras_socket_meas_accept(gras_socket_t peer); - /* @}*/ /** \defgroup GRAS_sock_file Using files as sockets * \ingroup GRAS_sock * - *
Top [\ref index]::[\ref GRAS_API]::[\ref GRAS_sock] - *
Prev [\ref GRAS_sock_meas] - *
Next
* * For debugging purpose, it is possible to deal with files as if they were sockets. * It can even be useful to store stuff in a portable manner, but writing messages to a file @@ -119,9 +70,12 @@ gras_socket_t gras_socket_meas_accept(gras_socket_t peer); */ /* @{*/ /* debuging functions */ -gras_socket_t gras_socket_client_from_file(const char*path); -gras_socket_t gras_socket_server_from_file(const char*path); - +XBT_PUBLIC(xbt_socket_t) gras_socket_client_from_file(const char *path); +XBT_PUBLIC(xbt_socket_t) gras_socket_server_from_file(const char *path); + /* @} */ - -#endif /* GRAS_TRANSPORT_H */ + +void gras_trp_sg_setup(xbt_trp_plugin_t plug); +void gras_trp_file_setup(xbt_trp_plugin_t plug); + +#endif /* GRAS_TRANSPORT_H */