-xbt_error_t gras_socket_client(const char *host,
- unsigned short port,
- /* OUT */ gras_socket_t *dst);
-xbt_error_t gras_socket_server(unsigned short port,
- /* OUT */ gras_socket_t *dst);
-void gras_socket_close(gras_socket_t sd);
-
-/* get information about socket */
-int gras_socket_my_port (gras_socket_t sock);
-int gras_socket_peer_port(gras_socket_t sock);
-char *gras_socket_peer_name(gras_socket_t sock);
-
-/* extended interface to get all details */
-xbt_error_t gras_socket_client_ext(const char *host,
- unsigned short port,
- unsigned long int bufSize,
- int raw,
- /* OUT */ gras_socket_t *dst);
-xbt_error_t gras_socket_server_ext(unsigned short port,
- unsigned long int bufSize,
- int raw,
- /* OUT */ gras_socket_t *dst);
-
-/* using raw sockets */
-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);
+/** \brief Simply create a client socket (to speak to a remote host) */
+XBT_PUBLIC(gras_socket_t) gras_socket_client(const char *host,
+ unsigned short port);
+XBT_PUBLIC(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) */
+XBT_PUBLIC(gras_socket_t) gras_socket_server(unsigned short port);
+XBT_PUBLIC(void) gras_socket_close(gras_socket_t sd);
+XBT_PUBLIC(void) gras_socket_close_voidp(void *sock);
+
+/** \brief Create a client socket, full interface to all relevant settings */
+XBT_PUBLIC(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_PUBLIC(gras_socket_t) gras_socket_server_ext(unsigned short port,
+ unsigned long int bufSize,
+ int measurement);
+XBT_PUBLIC(gras_socket_t)
+ gras_socket_server_range(unsigned short minport, unsigned short maxport,
+ unsigned long int buf_size, 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 */
+XBT_PUBLIC(int) gras_socket_my_port(gras_socket_t sock);
+/** @brief Get the port number on which this socket is connected on remote side
+ *
+ * This is the port declared on remote side with the
+ * gras_socket_master() function (if any, or a random number being uniq on
+ * the remote host). If remote used gras_socket_master() more than once, the
+ * lastly declared number will be used here.
+ *
+ * Note to BSD sockets experts: With BSD sockets, the sockaddr
+ * structure allows you to retrieve the port of the client socket on
+ * remote side, but it is of no use (from user perspective, it is
+ * some random number above 6000). That is why GRAS sockets differ
+ * from BSD ones here.
+ */
+
+XBT_PUBLIC(int) gras_socket_peer_port(gras_socket_t sock);
+/** Get the host name of the remote side */
+XBT_PUBLIC(char *) gras_socket_peer_name(gras_socket_t sock);
+/** Get the process name of the remote side */
+XBT_PUBLIC(char *) gras_socket_peer_proc(gras_socket_t sock);
+/* @}*/
+
+/** \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 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.
+ *
+ */
+/* @{*/