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 */
40 * @brief handle to a socket
42 struct GNUNET_NETWORK_Handle;
46 * @brief collection of IO descriptors
48 struct GNUNET_NETWORK_FDSet
52 * Maximum number of any socket socket descriptor in the set (plus one)
57 * Bitset with the descriptors.
63 * Linked list of handles
65 struct GNUNET_CONTAINER_SList *handles;
72 #include "gnunet_disk_lib.h"
73 #include "gnunet_time_lib.h"
77 * Accept a new connection on a socket. Configure it for non-blocking
78 * IO and mark it as non-inheritable to child processes (set the
79 * close-on-exec flag).
81 * @param desc bound socket
82 * @param address address of the connecting peer, may be NULL
83 * @param address_len length of address
84 * @return client socket
86 struct GNUNET_NETWORK_Handle *
87 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
88 struct sockaddr *address,
89 socklen_t * address_len);
94 * Box a native socket (and check that it is a socket).
96 * @param fd socket to box
97 * @return NULL on error (including not supported on target platform)
99 struct GNUNET_NETWORK_Handle *
100 GNUNET_NETWORK_socket_box_native (SOCKTYPE fd);
105 * Bind to a connected socket
107 * @param desc socket to bind
108 * @param address address to be bound
109 * @param address_len length of address
110 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
113 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
114 const struct sockaddr *address,
115 socklen_t address_len);
120 * @param desc socket to close
121 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
124 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
130 * @param desc socket to connect
131 * @param address peer address
132 * @param address_len of address
133 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
136 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
137 const struct sockaddr *address,
138 socklen_t address_len);
144 * @param desc socket to inspect
145 * @param level protocol level of the option
146 * @param optname identifier of the option
147 * @param optval options
148 * @param optlen length of optval
149 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
152 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
153 int level, int optname, void *optval,
160 * @param desc socket to start listening on
161 * @param backlog length of the listen queue
162 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
165 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
170 * How much data is available to be read on this descriptor?
174 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
179 * Read data from a connected socket (always non-blocking).
181 * @param buffer buffer
182 * @param length length of buffer
183 * @param src_addr either the source to recv from, or all zeroes
184 * to be filled in by recvfrom
185 * @param addrlen length of the addr
188 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
189 void *buffer, size_t length,
190 struct sockaddr *src_addr, socklen_t * addrlen);
194 * Read data from a connected socket (always non-blocking).
197 * @param buffer buffer
198 * @param length length of buffer
199 * @return number of bytes read
202 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
203 void *buffer, size_t length);
207 * Check if sockets meet certain conditions
208 * @param rfds set of sockets to be checked for readability
209 * @param wfds set of sockets to be checked for writability
210 * @param efds set of sockets to be checked for exceptions
211 * @param timeout relative value when to return
212 * @return number of selected sockets, GNUNET_SYSERR on error
215 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
216 struct GNUNET_NETWORK_FDSet *wfds,
217 struct GNUNET_NETWORK_FDSet *efds,
218 struct GNUNET_TIME_Relative timeout);
222 * Send data (always non-blocking).
225 * @param buffer data to send
226 * @param length size of the buffer
227 * @return number of bytes sent, GNUNET_SYSERR on error
230 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
231 const void *buffer, size_t length);
235 * Send data to a particular destination (always non-blocking).
236 * This function only works for UDP sockets.
239 * @param message data to send
240 * @param length size of the data
241 * @param dest_addr destination address
242 * @param dest_len length of address
243 * @return number of bytes sent, GNUNET_SYSERR on error
246 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
247 const void *message, size_t length,
248 const struct sockaddr *dest_addr,
256 * @param level protocol level of the option
257 * @param option_name option identifier
258 * @param option_value value to set
259 * @param option_len size of option_value
260 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
263 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level,
264 int option_name, const void *option_value,
265 socklen_t option_len);
269 * Shut down socket operations
272 * @param how type of shutdown
273 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
276 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how);
280 * Disable the "CORK" feature for communication with the given socket,
281 * forcing the OS to immediately flush the buffer on transmission
282 * instead of potentially buffering multiple messages. Essentially
283 * reduces the OS send buffers to zero.
286 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
289 GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc);
293 * Create a new socket. Configure it for non-blocking IO and
294 * mark it as non-inheritable to child processes (set the
295 * close-on-exec flag).
297 * @param domain domain of the socket
298 * @param type socket type
299 * @param protocol network protocol
300 * @return new socket, NULL on error
302 struct GNUNET_NETWORK_Handle *
303 GNUNET_NETWORK_socket_create (int domain, int type, int protocol);
307 * Reset FD set (clears all file descriptors).
309 * @param fds fd set to clear
312 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
316 * Add a socket to the FD set
318 * @param desc socket to add
321 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
322 const struct GNUNET_NETWORK_Handle *desc);
327 * Add a W32 file handle to the fd set
329 * @param h the file handle to add
332 GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet
338 * Check whether a socket is part of the fd set
341 * @return GNUNET_YES if the socket is in the set
344 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
345 const struct GNUNET_NETWORK_Handle *desc);
349 * Add one fd set to another
350 * @param dst the fd set to add to
351 * @param src the fd set to add from
354 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
355 const struct GNUNET_NETWORK_FDSet *src);
359 * Copy one fd set to another
360 * @param to destination
364 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
365 const struct GNUNET_NETWORK_FDSet *from);
369 * Return file descriptor for this network handle
371 * @param desc wrapper to process
372 * @return POSIX file descriptor
375 GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc);
379 * Copy a native fd set
380 * @param to destination
381 * @param from native source set
382 * @param nfds the biggest socket number in from + 1
385 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
386 const fd_set * from, int nfds);
390 * Set a native fd in a set
392 * @param to destination
393 * @param nfd native FD to set
396 GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd);
400 * Test native fd in a set
402 * @param to set to test, NULL for empty set
403 * @param nfd native FD to test, -1 for none
404 * @return GNUNET_YES if to contains nfd
407 GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
412 * Add a file handle to the fd set
414 * @param h the file handle to add
417 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
418 const struct GNUNET_DISK_FileHandle *h);
422 * Check if a file handle is part of an fd set
424 * @param h file handle
425 * @return GNUNET_YES if the file handle is part of the set
428 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
429 const struct GNUNET_DISK_FileHandle *h);
433 * Checks if two fd sets overlap
434 * @param fds1 first fd set
435 * @param fds2 second fd set
436 * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
439 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
440 const struct GNUNET_NETWORK_FDSet *fds2);
445 * @return a new fd set
447 struct GNUNET_NETWORK_FDSet *
448 GNUNET_NETWORK_fdset_create (void);
452 * Releases the associated memory of an fd set
456 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
459 #if 0 /* keep Emacsens' auto-indent happy */
466 #endif /* GNUNET_NETWORK_LIB_H */