X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2fad952ef4a63aedf6c8b2dc4e371de849f1e163..337c0de59186a44f7a146bc28628ee10f6e5f9ed:/include/gras/transport.h

diff --git a/include/gras/transport.h b/include/gras/transport.h
index 84c711336a..fbbbd5d55c 100644
--- a/include/gras/transport.h
+++ b/include/gras/transport.h
@@ -1,3 +1,4 @@
+
 /* $Id$ */
 
 /* transport - low level communication (send/receive bunches of bytes)      */
@@ -11,47 +12,52 @@
 #ifndef GRAS_TRANSPORT_H
 #define GRAS_TRANSPORT_H
 
-#include "xbt/error.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
+ * <i>server</i> socket on which it can listen for incoming messages and the
+ * other one must connect a <i>client</i> 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);
+gras_socket_t gras_socket_client(const char *host, unsigned short port);
 /** \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);
+gras_socket_t gras_socket_server(unsigned short port);
 /** \brief Close socket */
-void         gras_socket_close(gras_socket_t sd);
+void          gras_socket_close(gras_socket_t sd);
 
 /** \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 raw, 
-				    /* OUT */ gras_socket_t *dst);
+gras_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 raw,
-				    /* OUT */ gras_socket_t *dst);
-/*@}*/
-/** \name Retrieving data about sockets and peers 
+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
  * 
  * 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);
@@ -59,47 +65,49 @@ int   gras_socket_my_port  (gras_socket_t sock);
 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 raw sockets
+/** \defgroup GRAS_sock_meas Using measurement sockets
  *  \ingroup GRAS_sock
  * 
  * You may want to use sockets not to exchange valuable data (in messages), 
- * but to conduct some experiments such as bandwidth measurement. If so, try those raw sockets.
+ * 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 "raw" boolean set to true.
+ * You can only use those functions on sockets openned with the "measurement" boolean set to true.
  * 
- * \bug Raw sockets are not fully functionnal yet.
  */
-/*@{*/
+/* @{*/
+
 
-xbt_error_t gras_socket_raw_send(gras_socket_t peer, 
-				  unsigned int timeout,
-				  unsigned long int expSize, 
-				  unsigned long int msgSize);
-xbt_error_t gras_socket_raw_recv(gras_socket_t peer, 
-				  unsigned int timeout,
-				  unsigned long int expSize, 
-				  unsigned long int msgSize);
 
-/*@}*/
+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);
+            
+/* @}*/
 
-/** \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...
  * 
  * \bug Don't use '-' on windows. this file represents stdin or stdout, but I failed to deal with it on windows.
  */
-/*@{*/
+/* @{*/
 /* 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);
+gras_socket_t gras_socket_client_from_file(const char*path);
+gras_socket_t gras_socket_server_from_file(const char*path);
 					  
-/*@}*/
+/* @} */
    
 #endif /* GRAS_TRANSPORT_H */