2 This file is part of GNUnet.
3 (C) 2009 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 2, 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_network_lib.h
23 * @brief basic low-level networking interface
27 #ifndef GNUNET_NETWORK_LIB_H
28 #define GNUNET_NETWORK_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
41 * @brief handle to a socket
43 struct GNUNET_NETWORK_Handle;
46 * @brief collection of IO descriptors
48 struct GNUNET_NETWORK_FDSet;
51 #include "gnunet_disk_lib.h"
52 #include "gnunet_time_lib.h"
56 * Accept a new connection on a socket. Configure it for non-blocking
57 * IO and mark it as non-inheritable to child processes (set the
58 * close-on-exec flag).
60 * @param desc bound socket
61 * @param address address of the connecting peer, may be NULL
62 * @param address_len length of address
63 * @return client socket
65 struct GNUNET_NETWORK_Handle *GNUNET_NETWORK_socket_accept (const struct
75 * Bind to a connected socket
77 * @param desc socket to bind
78 * @param address address to be bound
79 * @param address_len length of address
80 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
82 int GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
83 const struct sockaddr *address,
84 socklen_t address_len);
89 * @param desc socket to close
90 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
92 int GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
97 * @param desc socket to connect
98 * @param address peer address
99 * @param address_len of address
100 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
102 int GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
103 const struct sockaddr *address,
104 socklen_t address_len);
110 * @param desc socket to inspect
111 * @param level protocol level of the option
112 * @param optname identifier of the option
113 * @param optval options
114 * @param optlen length of optval
115 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
117 int GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle
118 *desc, int level, int optname,
119 void *optval, socklen_t * optlen);
125 * @param desc socket to start listening on
126 * @param backlog length of the listen queue
127 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
129 int GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
133 * How much data is available to be read on this descriptor?
137 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
141 * Read data from a connected socket (always non-blocking).
143 * @param buffer buffer
144 * @param length length of buffer
145 * @param src_addr either the source to recv from, or all zeroes
146 * to be filled in by recvfrom
147 * @param addrlen length of the addr
150 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
151 void *buffer, size_t length,
152 struct sockaddr *src_addr,
153 socklen_t * addrlen);
156 * Read data from a connected socket (always non-blocking).
159 * @param buffer buffer
160 * @param length length of buffer
161 * @return number of bytes read
163 ssize_t GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
164 void *buffer, size_t length);
167 * Check if sockets meet certain conditions
168 * @param rfds set of sockets to be checked for readability
169 * @param wfds set of sockets to be checked for writability
170 * @param efds set of sockets to be checked for exceptions
171 * @param timeout relative value when to return
172 * @return number of selected sockets, GNUNET_SYSERR on error
174 int GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
175 struct GNUNET_NETWORK_FDSet *wfds,
176 struct GNUNET_NETWORK_FDSet *efds,
177 struct GNUNET_TIME_Relative timeout);
182 * Send data (always non-blocking).
185 * @param buffer data to send
186 * @param length size of the buffer
187 * @return number of bytes sent, GNUNET_SYSERR on error
189 ssize_t GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
190 const void *buffer, size_t length);
193 * Send data to a particular destination (always non-blocking).
194 * This function only works for UDP sockets.
197 * @param message data to send
198 * @param length size of the data
199 * @param dest_addr destination address
200 * @param dest_len length of address
201 * @return number of bytes sent, GNUNET_SYSERR on error
203 ssize_t GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle
204 *desc, const void *message,
206 const struct sockaddr *dest_addr,
212 * @param level protocol level of the option
213 * @param option_name option identifier
214 * @param option_value value to set
215 * @param option_len size of option_value
216 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
218 int GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
219 int level, int option_name,
220 const void *option_value,
221 socklen_t option_len);
224 * Shut down socket operations
226 * @param how type of shutdown
227 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
229 int GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
234 * Create a new socket. Configure it for non-blocking IO and
235 * mark it as non-inheritable to child processes (set the
236 * close-on-exec flag).
238 * @param domain domain of the socket
239 * @param type socket type
240 * @param protocol network protocol
241 * @return new socket, NULL on error
243 struct GNUNET_NETWORK_Handle *GNUNET_NETWORK_socket_create (int domain,
248 * Reset FD set (clears all file descriptors).
250 * @param fds fd set to clear
252 void GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
255 * Add a socket to the FD set
257 * @param desc socket to add
259 void GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
260 const struct GNUNET_NETWORK_Handle *desc);
264 * Check whether a socket is part of the fd set
267 * @return GNUNET_YES if the socket is in the set
269 int GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
270 const struct GNUNET_NETWORK_Handle *desc);
273 * Add one fd set to another
274 * @param dst the fd set to add to
275 * @param src the fd set to add from
277 void GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
278 const struct GNUNET_NETWORK_FDSet *src);
281 * Copy one fd set to another
282 * @param to destination
285 void GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
286 const struct GNUNET_NETWORK_FDSet *from);
289 * Return file descriptor for this network handle
291 int GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc);
293 * Copy a native fd set
294 * @param to destination
295 * @param from native source set
296 * @param nfds the biggest socket number in from + 1
298 void GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
299 const fd_set * from, int nfds);
302 * Add a file handle to the fd set
304 * @param h the file handle to add
306 void GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
307 const struct GNUNET_DISK_FileHandle *h);
310 * Check if a file handle is part of an fd set
312 * @param h file handle
313 * @return GNUNET_YES if the file handle is part of the set
315 int GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
316 const struct GNUNET_DISK_FileHandle
320 * Checks if two fd sets overlap
321 * @param fds1 first fd set
322 * @param fds2 second fd set
323 * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
325 int GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
326 const struct GNUNET_NETWORK_FDSet *fds2);
330 * @return a new fd set
332 struct GNUNET_NETWORK_FDSet *GNUNET_NETWORK_fdset_create (void);
335 * Releases the associated memory of an fd set
338 void GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
341 #if 0 /* keep Emacsens' auto-indent happy */
348 #endif /* GNUNET_NETWORK_LIB_H */