Two new functions

[simgrid.git] / include / gras / transport.h

diff --git a/include/gras/transport.h b/include/gras/transport.h
index 1e7ceac..02dc476 100644 (file)
--- a/include/gras/transport.h
+++ b/include/gras/transport.h
@@ -1,3 +1,4 @@
+
 /* $Id$ */
 
 /* transport - low level communication (send/receive bunches of bytes)      */
@@ -12,11 +13,23 @@
 #define GRAS_TRANSPORT_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 */
@@ -24,9 +37,9 @@ 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);
+gras_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);
 
 /** \brief Create a client socket, full interface to all relevant settings */
@@ -38,8 +51,12 @@ gras_socket_t gras_socket_client_ext(const char *host,
 gras_socket_t gras_socket_server_ext(unsigned short port,
                                     unsigned long int bufSize,
                                     int measurement);
+gras_socket_t
+gras_socket_server_range(unsigned short minport, unsigned short maxport,
+                        unsigned long int buf_size, int measurement);
+
 /* @}*/
-/** \name Retrieving data about sockets and peers 
+/** \defgroup GRAS_sock_info Retrieving data about sockets and peers 
  *  \ingroup GRAS_sock
  * 
  * Who are you talking to?
@@ -52,9 +69,11 @@ 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);
+/** Get the process name of the remote side */
+char *gras_socket_peer_proc(gras_socket_t sock);
 /* @}*/
 
-/** \name Using measurement sockets
+/** \defgroup GRAS_sock_meas Using measurement sockets
  *  \ingroup GRAS_sock
  * 
  * You may want to use sockets not to exchange valuable data (in messages), 
@@ -80,9 +99,10 @@ 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...