2 This file is part of GNUnet.
3 (C) 2011, Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_stream_lib.h
23 * @brief stream handling using mesh API
24 * @author Sree Harsha Totakura
27 #ifndef GNUNET_STREAM_LIB_H_
28 #define GNUNET_STREAM_LIB_H_
38 #include "gnunet_util_lib.h"
39 #include "gnunet_mesh_service.h"
44 enum GNUNET_STREAM_Status
47 * All previous read/write operations are successfully done
52 * A timeout occured while reading/writing the stream
54 GNUNET_STREAM_TIMEOUT = 1,
57 * Other side has shutdown the socket for this type of operation
60 GNUNET_STREAM_SHUTDOWN = 2,
63 * A serious error occured while operating of this stream
65 GNUNET_STREAM_SYSERR = 3
69 * Opaque handler for stream
71 struct GNUNET_STREAM_Socket;
74 * Functions of this type will be called when a stream is established
76 * @param cls the closure from GNUNET_STREAM_open
77 * @param socket socket to use to communicate with the other side (read/write)
79 typedef void (*GNUNET_STREAM_OpenCallback) (void *cls,
80 struct GNUNET_STREAM_Socket *socket);
84 * Tries to open a stream to the target peer
86 * @param target the target peer to which the stream has to be opened
87 * @param app_port the application port number which uniquely identifies this
89 * @param open_cb this function will be called after stream has be established
90 * @param open_cb_cls the closure for open_cb
91 * @return if successful it returns the stream socket; NULL if stream cannot be
94 struct GNUNET_STREAM_Socket *
95 GNUNET_STREAM_open (const struct GNUNET_PeerIdentity *target,
96 GNUNET_MESH_ApplicationType app_port,
97 GNUNET_STREAM_OpenCallback open_cb,
102 * Shutdown the stream for reading or writing (man 2 shutdown).
104 * @param socket the stream socket
105 * @param how SHUT_RD, SHUT_WR or SHUT_RDWR
108 GNUNET_STREAM_shutdown (struct GNUNET_STREAM_Socket *socket,
115 * @param socket the stream socket
118 GNUNET_STREAM_close (struct GNUNET_STREAM_Socket *socket);
122 * Functions of this type are called upon new stream connection from other peers
124 * @param cls the closure from GNUNET_STREAM_listen
125 * @param socket the socket representing the stream
126 * @param initiator the identity of the peer who wants to establish a stream
128 * @return GNUNET_OK to keep the socket open, GNUNET_SYSERR to close the
129 * stream (the socket will be invalid after the call)
131 typedef int (*GNUNET_STREAM_ListenCallback) (void *cls,
132 struct GNUNET_STREAM_Socket *socket,
134 GNUNET_PeerIdentity *initiator);
138 * A socket for listening.
140 struct GNUNET_STREAM_ListenSocket;
143 * Listens for stream connections for a specific application ports
145 * @param app_port the application port for which new streams will be accepted
146 * @param listen_cb this function will be called when a peer tries to establish
148 * @param listen_cb_cls closure for listen_cb
149 * @return listen socket, NULL for any error
151 struct GNUNET_STREAM_ListenSocket *
152 GNUNET_STREAM_listen (GNUNET_MESH_ApplicationType app_port,
153 GNUNET_STREAM_ListenCallback listen_cb,
154 void *listen_cb_cls);
158 * Closes the listen socket
160 * @param socket the listen socket
163 GNUNET_STREAM_listen_close (struct GNUNET_STREAM_ListenSocket *socket);
167 * Functions of this signature are called whenever writing operations
168 * on a stream are executed
170 * @param cls the closure from GNUNET_STREAM_write/read
171 * @param status the status of the stream at the time this function is called
172 * @param size the number of bytes read or written
174 typedef void (*GNUNET_STREAM_CompletionContinuation) (void *cls,
175 enum GNUNET_STREAM_Status
181 * Handle to cancel IO operations.
183 struct GNUNET_STREAM_IOHandle;
187 * Tries to write the given data to the stream
189 * @param socket the socket representing a stream
190 * @param data the data buffer from where the data is written into the stream
191 * @param size the number of bytes to be written from the data buffer
192 * @param timeout the timeout period
193 * @param write_cont the function to call upon writing some bytes into the stream
194 * @param write_cont_cls the closure
195 * @return handle to cancel the operation
197 struct GNUNET_STREAM_IOHandle *
198 GNUNET_STREAM_write (struct GNUNET_STREAM_Socket *socket,
201 struct GNUNET_TIME_Relative timeout,
202 GNUNET_STREAM_CompletionContinuation write_cont,
203 void *write_cont_cls);
207 * Functions of this signature are called whenever data is available from the
210 * @param cls the closure from GNUNET_STREAM_write/read
211 * @param status the status of the stream at the time this function is called
212 * @param data traffic from the other side
213 * @param size the number of bytes available in data read
214 * @return number of bytes of processed from 'data' (any data remaining should be
215 * given to the next time the read processor is called).
217 typedef size_t (*GNUNET_STREAM_DataProcessor) (void *cls,
218 enum GNUNET_STREAM_Status status,
224 * Tries to read data from the stream
226 * @param socket the socket representing a stream
227 * @param timeout the timeout period
228 * @param proc function to call with data (once only)
229 * @param proc_cls the closure for proc
230 * @return handle to cancel the operation
232 struct GNUNET_STREAM_IOHandle *
233 GNUNET_STREAM_read (const struct GNUNET_STREAM_Socket *socket,
234 struct GNUNET_TIME_Relative timeout,
235 GNUNET_STREAM_DataProcessor proc,
240 * Cancel pending read or write operation.
242 * @param ioh handle to operation to cancel
245 GNUNET_STREAM_io_cancel (struct GNUNET_STREAM_IOHandle *ioh);