src/include/gnunet_stream_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011, 2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_stream_lib.h
  23  * @brief stream handling using mesh API
  24  * @author Sree Harsha Totakura
  25  */
  26
  27 #ifndef GNUNET_STREAM_LIB_H
  28 #define GNUNET_STREAM_LIB_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_util_lib.h"
  39 #include "gnunet_mesh_service.h"
  40
  41 /**
  42  * Stream status
  43  */
  44 enum GNUNET_STREAM_Status
  45   {
  46     /**
  47      * All previous read/write operations are successfully done
  48      */
  49     GNUNET_STREAM_OK = 0,
  50
  51     /**
  52      * A timeout occured while reading/writing the stream
  53      */
  54     GNUNET_STREAM_TIMEOUT = 1,
  55
  56     /**
  57      * Other side has shutdown the socket for this type of operation
  58      * (reading/writing)
  59      */
  60     GNUNET_STREAM_SHUTDOWN = 2,
  61
  62     /**
  63      * A serious error occured while operating on this stream
  64      */
  65     GNUNET_STREAM_SYSERR = 3
  66   };
  67
  68 /**
  69  * Opaque handler for stream
  70  */
  71 struct GNUNET_STREAM_Socket;
  72
  73 /**
  74  * Functions of this type will be called when a stream is established
  75  *
  76  * @param cls the closure from GNUNET_STREAM_open
  77  * @param socket socket to use to communicate with the other side (read/write)
  78  */
  79 typedef void (*GNUNET_STREAM_OpenCallback) (void *cls,
  80                                             struct GNUNET_STREAM_Socket *socket);
  81
  82
  83 /**
  84  * Options for the stream.
  85  */
  86 enum GNUNET_STREAM_Option
  87   {
  88     /**
  89      * End of the option list.
  90      */
  91     GNUNET_STREAM_OPTION_END = 0,
  92
  93     /**
  94      * Option to set the initial retransmission timeout (when do we retransmit
  95      * a packet that did not yield an acknowledgement for the first time?).
  96      * Repeated retransmissions will then use an exponential back-off.
  97      * Takes a 'struct GNUNET_TIME_Relative' as the only argument.  A value
  98      * of '0' means to use the round-trip time (plus a tiny grace period);
  99      * this is also the default.
 100      */
 101     GNUNET_STREAM_OPTION_INITIAL_RETRANSMIT_TIMEOUT
 102   };
 103
 104
 105 /**
 106  * Tries to open a stream to the target peer
 107  *
 108  * @param cfg configuration to use
 109  * @param target the target peer to which the stream has to be opened
 110  * @param app_port the application port number which uniquely identifies this
 111  *            stream
 112  * @param open_cb this function will be called after stream has be established
 113  * @param open_cb_cls the closure for open_cb
 114  * @param ... options to the stream, terminated by GNUNET_STREAM_OPTION_END
 115  * @return if successful it returns the stream socket; NULL if stream cannot be
 116  *         opened
 117  */
 118 struct GNUNET_STREAM_Socket *
 119 GNUNET_STREAM_open (const struct GNUNET_CONFIGURATION_Handle *cfg,
 120                     const struct GNUNET_PeerIdentity *target,
 121                     GNUNET_MESH_ApplicationType app_port,
 122                     GNUNET_STREAM_OpenCallback open_cb,
 123                     void *open_cb_cls,
 124                     ...);
 125
 126
 127 /**
 128  * Shutdown the stream for reading or writing (man 2 shutdown).
 129  *
 130  * @param socket the stream socket
 131  * @param how SHUT_RD, SHUT_WR or SHUT_RDWR
 132  */
 133 void
 134 GNUNET_STREAM_shutdown (struct GNUNET_STREAM_Socket *socket,
 135                         int how);
 136
 137
 138 /**
 139  * Closes the stream
 140  *
 141  * @param socket the stream socket
 142  */
 143 void
 144 GNUNET_STREAM_close (struct GNUNET_STREAM_Socket *socket);
 145
 146
 147 /**
 148  * Functions of this type are called upon new stream connection from other peers
 149  *
 150  * @param cls the closure from GNUNET_STREAM_listen
 151  * @param socket the socket representing the stream
 152  * @param initiator the identity of the peer who wants to establish a stream
 153  *            with us
 154  * @return GNUNET_OK to keep the socket open, GNUNET_SYSERR to close the
 155  *             stream (the socket will be invalid after the call)
 156  */
 157 typedef int (*GNUNET_STREAM_ListenCallback) (void *cls,
 158                                              struct GNUNET_STREAM_Socket *socket,
 159                                              const struct
 160                                              GNUNET_PeerIdentity *initiator);
 161
 162
 163 /**
 164  * A socket for listening.
 165  */
 166 struct GNUNET_STREAM_ListenSocket;
 167
 168 /**
 169  * Listens for stream connections for a specific application ports
 170  *
 171  * @param cfg the configuration to use
 172  * @param app_port the application port for which new streams will be accepted
 173  * @param listen_cb this function will be called when a peer tries to establish
 174  *            a stream with us
 175  * @param listen_cb_cls closure for listen_cb
 176  * @return listen socket, NULL for any error
 177  */
 178 struct GNUNET_STREAM_ListenSocket *
 179 GNUNET_STREAM_listen (const struct GNUNET_CONFIGURATION_Handle *cfg,
 180                       GNUNET_MESH_ApplicationType app_port,
 181                       GNUNET_STREAM_ListenCallback listen_cb,
 182                       void *listen_cb_cls);
 183
 184
 185 /**
 186  * Closes the listen socket
 187  *
 188  * @param lsocket the listen socket
 189  */
 190 void
 191 GNUNET_STREAM_listen_close (struct GNUNET_STREAM_ListenSocket *lsocket);
 192
 193
 194 /**
 195  * Functions of this signature are called whenever writing operations
 196  * on a stream are executed
 197  *
 198  * @param cls the closure from GNUNET_STREAM_write
 199  * @param status the status of the stream at the time this function is called
 200  * @param size the number of bytes written
 201  */
 202 typedef void (*GNUNET_STREAM_CompletionContinuation) (void *cls,
 203                                                       enum GNUNET_STREAM_Status
 204                                                       status,
 205                                                       size_t size);
 206
 207
 208 /**
 209  * Handle to cancel IO write operations.
 210  */
 211 struct GNUNET_STREAM_IOWriteHandle;
 212
 213
 214 /**
 215  * Handle to cancel IO read operations.
 216  */
 217 struct GNUNET_STREAM_IOReadHandle;
 218
 219 /**
 220  * Tries to write the given data to the stream. The maximum size of data that
 221  * can be written as part of a write operation is (64 * (64000 - sizeof (struct
 222  * GNUNET_STREAM_DataMessage))). If size is greater than this it is not an API
 223  * violation, however only the said number of maximum bytes will be written.
 224  *
 225  * @param socket the socket representing a stream
 226  * @param data the data buffer from where the data is written into the stream
 227  * @param size the number of bytes to be written from the data buffer
 228  * @param timeout the timeout period
 229  * @param write_cont the function to call upon writing some bytes into the
 230  *          stream
 231  * @param write_cont_cls the closure
 232  * @return handle to cancel the operation; NULL if a previous write is pending
 233  */
 234 struct GNUNET_STREAM_IOWriteHandle *
 235 GNUNET_STREAM_write (struct GNUNET_STREAM_Socket *socket,
 236                      const void *data,
 237                      size_t size,
 238                      struct GNUNET_TIME_Relative timeout,
 239                      GNUNET_STREAM_CompletionContinuation write_cont,
 240                      void *write_cont_cls);
 241
 242
 243 /**
 244  * Functions of this signature are called whenever data is available from the
 245  * stream.
 246  *
 247  * @param cls the closure from GNUNET_STREAM_read
 248  * @param status the status of the stream at the time this function is called
 249  * @param data traffic from the other side
 250  * @param size the number of bytes available in data read; will be 0 on timeout
 251  * @return number of bytes of processed from 'data' (any data remaining should be
 252  *         given to the next time the read processor is called).
 253  */
 254 typedef size_t (*GNUNET_STREAM_DataProcessor) (void *cls,
 255                                                enum GNUNET_STREAM_Status status,
 256                                                const void *data,
 257                                                size_t size);
 258
 259
 260 /**
 261  * Tries to read data from the stream
 262  *
 263  * @param socket the socket representing a stream
 264  * @param timeout the timeout period
 265  * @param proc function to call with data (once only)
 266  * @param proc_cls the closure for proc
 267  * @return handle to cancel the operation
 268  */
 269 struct GNUNET_STREAM_IOReadHandle *
 270 GNUNET_STREAM_read (struct GNUNET_STREAM_Socket *socket,
 271                     struct GNUNET_TIME_Relative timeout,
 272                     GNUNET_STREAM_DataProcessor proc,
 273                     void *proc_cls);
 274
 275
 276 /**
 277  * Cancels pending write operation. Also cancels packet retransmissions which
 278  * may have resulted otherwise.
 279  *
 280  * CAUTION: Normally a write operation is considered successful if the data
 281  * given to it is sent and acknowledged by the receiver. As data is divided
 282  * into packets, it is possible that not all packets are received by the
 283  * receiver. Any missing packets are then retransmitted till the receiver
 284  * acknowledges all packets or until a timeout . During this scenario if the
 285  * write operation is cancelled all such retransmissions are also
 286  * cancelled. This may leave the receiver's receive buffer incompletely filled
 287  * as some missing packets are never retransmitted. So this operation should be
 288  * used before shutting down transmission from our side or before closing the
 289  * socket.
 290  *
 291  * @param ioh handle to operation to cancel
 292  */
 293 void
 294 GNUNET_STREAM_io_write_cancel (struct GNUNET_STREAM_IOWriteHandle *iowh);
 295
 296
 297 /**
 298  * Cancel pending read operation.
 299  *
 300  * @param ioh handle to operation to cancel
 301  */
 302 void
 303 GNUNET_STREAM_io_read_cancel (struct GNUNET_STREAM_IOReadHandle *iorh);
 304
 305
 306 #if 0
 307 {
 308 #endif
 309 #ifdef __cplusplus
 310 }
 311 #endif
 312
 313 #endif  /* STREAM_PROTOCOL_H */