X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/61854023a2f6440223cddb107a84a5c006b2be56..c40ca1c8de2080575f5b3a0de33a6d4bf6474f10:/include/gras/transport.h
diff --git a/include/gras/transport.h b/include/gras/transport.h
index 58ce4b09b4..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,82 +11,57 @@
#ifndef GRAS_TRANSPORT_H
#define GRAS_TRANSPORT_H
-#include "xbt/error.h"
+#include "xbt/socket.h"
/** \addtogroup GRAS_sock
- * \brief Socket handling (Communication facility).
+ * \brief Socket handling
+ *
+ * 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 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.
+ *
*/
-/** \name Socket creation functions
+/** \defgroup GRAS_sock_create Socket creation functions
* \ingroup GRAS_sock
+ *
*/
/* @{*/
-/** \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) */
-xbt_error_t gras_socket_client(const char *host,
- unsigned short port,
- /* OUT */ gras_socket_t *dst);
+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) */
-xbt_error_t gras_socket_server(unsigned short port,
- /* OUT */ gras_socket_t *dst);
-/** \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 */
-xbt_error_t gras_socket_client_ext(const char *host,
- unsigned short port,
- unsigned long int bufSize,
- int measurement,
- /* OUT */ gras_socket_t *dst);
+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 */
-xbt_error_t gras_socket_server_ext(unsigned short port,
- unsigned long int bufSize,
- int measurement,
- /* OUT */ gras_socket_t *dst);
-/* @}*/
-/** \name Retrieving data about sockets and peers
- * \ingroup GRAS_sock
- *
- * Who are you talking to?
- */
-/* @{*/
-
-/** 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);
-/* @}*/
-
-/** \name Using measurement sockets
- * \ingroup GRAS_sock
- *
- * 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.
- *
- * \bug Measurement sockets are not fully functionnal yet.
- */
-/* @{*/
-
-xbt_error_t gras_socket_meas_send(gras_socket_t peer,
- unsigned int timeout,
- unsigned long int expSize,
- unsigned long int msgSize);
-xbt_error_t gras_socket_meas_recv(gras_socket_t peer,
- unsigned int timeout,
- unsigned long int expSize,
- unsigned long int msgSize);
+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);
/* @}*/
-/** \name Using files as sockets
+/** \defgroup GRAS_sock_file Using files as sockets
* \ingroup GRAS_sock
*
+ *
* 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
* may be strange...
@@ -95,11 +70,12 @@ xbt_error_t gras_socket_meas_recv(gras_socket_t peer,
*/
/* @{*/
/* debuging functions */
-xbt_error_t gras_socket_client_from_file(const char*path,
- /* OUT */ gras_socket_t *dst);
-xbt_error_t gras_socket_server_from_file(const char*path,
- /* OUT */ gras_socket_t *dst);
-
+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 */