include/gras/transport.h

   1
   2 /* $Id$ */
   3
   4 /* transport - low level communication (send/receive bunches of bytes)      */
   5 /* module's public interface exported to end user.                          */
   6
   7 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
   8
   9 /* This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the license (GNU LGPL) which comes with this package. */
  11
  12 #ifndef GRAS_TRANSPORT_H
  13 #define GRAS_TRANSPORT_H
  14
  15 /** \addtogroup GRAS_sock
  16  *  \brief Socket handling
  17  *
  18  * The model of communications in GRAS is very close to the BSD socket one.
  19  * To get two hosts exchanging data, one of them need to open a
  20  * <i>server</i> socket on which it can listen for incoming messages and the
  21  * other one must connect a <i>client</i> socket onto the server one.
  22  *
  23  * The main difference is that you cannot exchange arbitrary bytes on
  24  * sockets, but messages. See the \ref GRAS_msg section for details.
  25  *
  26  * If you need an example of how to use sockets, check \ref GRAS_ex_ping.
  27  *
  28  */
  29
  30 /** \defgroup GRAS_sock_create Socket creation functions
  31  *  \ingroup GRAS_sock
  32  *
  33  */
  34 /* @{*/
  35 /** \brief Opaque type describing a socket */
  36 typedef struct s_gras_socket *gras_socket_t;
  37
  38 /** \brief Simply create a client socket (to speak to a remote host) */
  39 gras_socket_t gras_socket_client(const char *host, unsigned short port);
  40 /** \brief Simply create a server socket (to ear from remote hosts speaking to you) */
  41 gras_socket_t gras_socket_server(unsigned short port);
  42 /** \brief Close socket */
  43 void          gras_socket_close(gras_socket_t sd);
  44
  45 /** \brief Create a client socket, full interface to all relevant settings */
  46 gras_socket_t gras_socket_client_ext(const char *host,
  47                                      unsigned short port,
  48                                      unsigned long int bufSize,
  49                                      int measurement);
  50 /** \brief Create a server socket, full interface to all relevant settings */
  51 gras_socket_t gras_socket_server_ext(unsigned short port,
  52                                      unsigned long int bufSize,
  53                                      int measurement);
  54 /* @}*/
  55 /** \defgroup GRAS_sock_info Retrieving data about sockets and peers
  56  *  \ingroup GRAS_sock
  57  *
  58  * Who are you talking to?
  59  */
  60 /* @{*/
  61
  62 /** Get the port number on which this socket is connected on my side */
  63 int   gras_socket_my_port  (gras_socket_t sock);
  64 /** Get the port number on which this socket is connected on remote side */
  65 int   gras_socket_peer_port(gras_socket_t sock);
  66 /** Get the host name of the remote side */
  67 char *gras_socket_peer_name(gras_socket_t sock);
  68 /* @}*/
  69
  70 /** \defgroup GRAS_sock_meas Using measurement sockets
  71  *  \ingroup GRAS_sock
  72  *
  73  * You may want to use sockets not to exchange valuable data (in messages),
  74  * but to conduct some bandwidth measurements and related experiments. If so, try those measurement sockets.
  75  *
  76  * You can only use those functions on sockets openned with the "measurement" boolean set to true.
  77  *
  78  */
  79 /* @{*/
  80
  81
  82
  83 int gras_socket_is_meas(gras_socket_t sock);
  84 void gras_socket_meas_send(gras_socket_t peer,
  85                            unsigned int timeout,
  86                            unsigned long int expSize,
  87                            unsigned long int msgSize);
  88 void gras_socket_meas_recv(gras_socket_t peer,
  89                            unsigned int timeout,
  90                            unsigned long int expSize,
  91                            unsigned long int msgSize);
  92 gras_socket_t gras_socket_meas_accept(gras_socket_t peer);
  93
  94 /* @}*/
  95
  96 /** \defgroup GRAS_sock_file Using files as sockets
  97  *  \ingroup GRAS_sock
  98  *
  99  *
 100  * For debugging purpose, it is possible to deal with files as if they were sockets.
 101  * It can even be useful to store stuff in a portable manner, but writing messages to a file
 102  * may be strange...
 103  *
 104  * \bug Don't use '-' on windows. this file represents stdin or stdout, but I failed to deal with it on windows.
 105  */
 106 /* @{*/
 107 /* debuging functions */
 108 gras_socket_t gras_socket_client_from_file(const char*path);
 109 gras_socket_t gras_socket_server_from_file(const char*path);
 110
 111 /* @} */
 112
 113 #endif /* GRAS_TRANSPORT_H */