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;
71 #include "gnunet_disk_lib.h"
72 #include "gnunet_time_lib.h"
76 * Given a unixpath that is too long (larger than UNIX_PATH_MAX),
77 * shorten it to an acceptable length while keeping it unique
78 * and making sure it remains a valid filename (if possible).
80 * @param unixpath long path, will be freed (or same pointer returned
81 * with moved 0-termination).
82 * @return shortened unixpath, NULL on error
85 GNUNET_NETWORK_shorten_unixpath (char *unixpath);
89 * Accept a new connection on a socket. Configure it for non-blocking
90 * IO and mark it as non-inheritable to child processes (set the
91 * close-on-exec flag).
93 * @param desc bound socket
94 * @param address address of the connecting peer, may be NULL
95 * @param address_len length of address
96 * @return client socket
98 struct GNUNET_NETWORK_Handle *
99 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
100 struct sockaddr *address,
101 socklen_t * address_len);
105 * Box a native socket (and check that it is a socket).
107 * @param fd socket to box
108 * @return NULL on error (including not supported on target platform)
110 struct GNUNET_NETWORK_Handle *
111 GNUNET_NETWORK_socket_box_native (SOCKTYPE fd);
115 * Bind to a connected socket
117 * @param desc socket to bind
118 * @param address address to be bound
119 * @param address_len length of address
120 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
123 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
124 const struct sockaddr *address,
125 socklen_t address_len);
130 * @param desc socket to close
131 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
134 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
140 * @param desc socket to connect
141 * @param address peer address
142 * @param address_len of address
143 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
146 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
147 const struct sockaddr *address,
148 socklen_t address_len);
154 * @param desc socket to inspect
155 * @param level protocol level of the option
156 * @param optname identifier of the option
157 * @param optval options
158 * @param optlen length of optval
159 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
162 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
163 int level, int optname, void *optval,
170 * @param desc socket to start listening on
171 * @param backlog length of the listen queue
172 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
175 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
180 * How much data is available to be read on this descriptor?
184 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
189 * Read data from a connected socket (always non-blocking).
191 * @param buffer buffer
192 * @param length length of buffer
193 * @param src_addr either the source to recv from, or all zeroes
194 * to be filled in by recvfrom
195 * @param addrlen length of the addr
198 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
199 void *buffer, size_t length,
200 struct sockaddr *src_addr, socklen_t *addrlen);
204 * Read data from a connected socket (always non-blocking).
207 * @param buffer buffer
208 * @param length length of buffer
209 * @return number of bytes read
212 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
213 void *buffer, size_t length);
217 * Check if sockets meet certain conditions
218 * @param rfds set of sockets to be checked for readability
219 * @param wfds set of sockets to be checked for writability
220 * @param efds set of sockets to be checked for exceptions
221 * @param timeout relative value when to return
222 * @return number of selected sockets, GNUNET_SYSERR on error
225 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
226 struct GNUNET_NETWORK_FDSet *wfds,
227 struct GNUNET_NETWORK_FDSet *efds,
228 struct GNUNET_TIME_Relative timeout);
232 * Send data (always non-blocking).
235 * @param buffer data to send
236 * @param length size of the buffer
237 * @return number of bytes sent, GNUNET_SYSERR on error
240 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
241 const void *buffer, size_t length);
245 * Send data to a particular destination (always non-blocking).
246 * This function only works for UDP sockets.
249 * @param message data to send
250 * @param length size of the data
251 * @param dest_addr destination address
252 * @param dest_len length of address
253 * @return number of bytes sent, GNUNET_SYSERR on error
256 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
257 const void *message, size_t length,
258 const struct sockaddr *dest_addr,
266 * @param level protocol level of the option
267 * @param option_name option identifier
268 * @param option_value value to set
269 * @param option_len size of option_value
270 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
273 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level,
274 int option_name, const void *option_value,
275 socklen_t option_len);
279 * Shut down socket operations
282 * @param how type of shutdown
283 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
286 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how);
290 * Disable the "CORK" feature for communication with the given socket,
291 * forcing the OS to immediately flush the buffer on transmission
292 * instead of potentially buffering multiple messages. Essentially
293 * reduces the OS send buffers to zero.
296 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
299 GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc);
303 * Create a new socket. Configure it for non-blocking IO and
304 * mark it as non-inheritable to child processes (set the
305 * close-on-exec flag).
307 * @param domain domain of the socket
308 * @param type socket type
309 * @param protocol network protocol
310 * @return new socket, NULL on error
312 struct GNUNET_NETWORK_Handle *
313 GNUNET_NETWORK_socket_create (int domain, int type, int protocol);
317 * Reset FD set (clears all file descriptors).
319 * @param fds fd set to clear
322 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
326 * Add a socket to the FD set
328 * @param desc socket to add
331 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
332 const struct GNUNET_NETWORK_Handle *desc);
337 * Add a W32 file handle to the fd set
339 * @param h the file handle to add
342 GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet
348 * Check whether a socket is part of the fd set
351 * @return GNUNET_YES if the socket is in the set
354 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
355 const struct GNUNET_NETWORK_Handle *desc);
359 * Add one fd set to another
360 * @param dst the fd set to add to
361 * @param src the fd set to add from
364 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
365 const struct GNUNET_NETWORK_FDSet *src);
369 * Copy one fd set to another
370 * @param to destination
374 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
375 const struct GNUNET_NETWORK_FDSet *from);
379 * Return file descriptor for this network handle
381 * @param desc wrapper to process
382 * @return POSIX file descriptor
385 GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc);
389 * Return the sockaddr for this network handle
391 * @param desc wrapper to process
392 * @return POSIX file descriptor
395 GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc);
399 * Return sockaddr length for this network handle
401 * @param desc wrapper to process
402 * @return socklen_t for sockaddr
405 GNUNET_NETWORK_get_addrlen (struct GNUNET_NETWORK_Handle *desc);
409 * Copy a native fd set
410 * @param to destination
411 * @param from native source set
412 * @param nfds the biggest socket number in from + 1
415 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
416 const fd_set * from, int nfds);
420 * Set a native fd in a set
422 * @param to destination
423 * @param nfd native FD to set
426 GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd);
430 * Test native fd in a set
432 * @param to set to test, NULL for empty set
433 * @param nfd native FD to test, -1 for none
434 * @return GNUNET_YES if to contains nfd
437 GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
442 * Add a file handle to the fd set
444 * @param h the file handle to add
447 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
448 const struct GNUNET_DISK_FileHandle *h);
452 * Check if a file handle is part of an fd set
454 * @param h file handle
455 * @return GNUNET_YES if the file handle is part of the set
458 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
459 const struct GNUNET_DISK_FileHandle *h);
463 * Checks if two fd sets overlap
464 * @param fds1 first fd set
465 * @param fds2 second fd set
466 * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
469 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
470 const struct GNUNET_NETWORK_FDSet *fds2);
475 * @return a new fd set
477 struct GNUNET_NETWORK_FDSet *
478 GNUNET_NETWORK_fdset_create (void);
482 * Releases the associated memory of an fd set
486 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
489 #if 0 /* keep Emacsens' auto-indent happy */
496 #endif /* GNUNET_NETWORK_LIB_H */