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"
75 * Test if the given protocol family is supported by this system.
77 * @param pf protocol family to test (PF_INET, PF_INET6, PF_UNIX)
78 * @return GNUNET_OK if the PF is supported
81 GNUNET_NETWORK_test_pf (int pf);
85 * Given a unixpath that is too long (larger than UNIX_PATH_MAX),
86 * shorten it to an acceptable length while keeping it unique
87 * and making sure it remains a valid filename (if possible).
89 * @param unixpath long path, will be freed (or same pointer returned
90 * with moved 0-termination).
91 * @return shortened unixpath, NULL on error
94 GNUNET_NETWORK_shorten_unixpath (char *unixpath);
98 * Accept a new connection on a socket. Configure it for non-blocking
99 * IO and mark it as non-inheritable to child processes (set the
100 * close-on-exec flag).
102 * @param desc bound socket
103 * @param address address of the connecting peer, may be NULL
104 * @param address_len length of address
105 * @return client socket
107 struct GNUNET_NETWORK_Handle *
108 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
109 struct sockaddr *address,
110 socklen_t * address_len);
114 * Box a native socket (and check that it is a socket).
116 * @param fd socket to box
117 * @return NULL on error (including not supported on target platform)
119 struct GNUNET_NETWORK_Handle *
120 GNUNET_NETWORK_socket_box_native (SOCKTYPE fd);
124 * Set if a socket should use blocking or non-blocking IO.
127 * @param doBlock blocking mode
128 * @return GNUNET_OK on success, GNUNET_SYSERR on error
131 GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
136 * Bind to a connected socket
138 * @param desc socket to bind
139 * @param address address to be bound
140 * @param address_len length of address
141 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
144 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
145 const struct sockaddr *address,
146 socklen_t address_len);
151 * @param desc socket to close
152 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
155 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
161 * @param desc socket to connect
162 * @param address peer address
163 * @param address_len of address
164 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
167 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
168 const struct sockaddr *address,
169 socklen_t address_len);
175 * @param desc socket to inspect
176 * @param level protocol level of the option
177 * @param optname identifier of the option
178 * @param optval options
179 * @param optlen length of optval
180 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
183 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
184 int level, int optname, void *optval,
191 * @param desc socket to start listening on
192 * @param backlog length of the listen queue
193 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
196 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
201 * How much data is available to be read on this descriptor?
205 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
210 * Read data from a connected socket (always non-blocking).
212 * @param buffer buffer
213 * @param length length of buffer
214 * @param src_addr either the source to recv from, or all zeroes
215 * to be filled in by recvfrom
216 * @param addrlen length of the addr
219 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
220 void *buffer, size_t length,
221 struct sockaddr *src_addr, socklen_t *addrlen);
225 * Read data from a connected socket (always non-blocking).
228 * @param buffer buffer
229 * @param length length of buffer
230 * @return number of bytes read
233 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
234 void *buffer, size_t length);
238 * Check if sockets meet certain conditions
239 * @param rfds set of sockets to be checked for readability
240 * @param wfds set of sockets to be checked for writability
241 * @param efds set of sockets to be checked for exceptions
242 * @param timeout relative value when to return
243 * @return number of selected sockets, GNUNET_SYSERR on error
246 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
247 struct GNUNET_NETWORK_FDSet *wfds,
248 struct GNUNET_NETWORK_FDSet *efds,
249 struct GNUNET_TIME_Relative timeout);
253 * Send data (always non-blocking).
256 * @param buffer data to send
257 * @param length size of the buffer
258 * @return number of bytes sent, GNUNET_SYSERR on error
261 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
262 const void *buffer, size_t length);
266 * Send data to a particular destination (always non-blocking).
267 * This function only works for UDP sockets.
270 * @param message data to send
271 * @param length size of the data
272 * @param dest_addr destination address
273 * @param dest_len length of address
274 * @return number of bytes sent, GNUNET_SYSERR on error
277 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
278 const void *message, size_t length,
279 const struct sockaddr *dest_addr,
287 * @param level protocol level of the option
288 * @param option_name option identifier
289 * @param option_value value to set
290 * @param option_len size of option_value
291 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
294 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level,
295 int option_name, const void *option_value,
296 socklen_t option_len);
300 * Shut down socket operations
303 * @param how type of shutdown
304 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
307 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how);
311 * Disable the "CORK" feature for communication with the given socket,
312 * forcing the OS to immediately flush the buffer on transmission
313 * instead of potentially buffering multiple messages. Essentially
314 * reduces the OS send buffers to zero.
317 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
320 GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc);
324 * Create a new socket. Configure it for non-blocking IO and
325 * mark it as non-inheritable to child processes (set the
326 * close-on-exec flag).
328 * @param domain domain of the socket
329 * @param type socket type
330 * @param protocol network protocol
331 * @return new socket, NULL on error
333 struct GNUNET_NETWORK_Handle *
334 GNUNET_NETWORK_socket_create (int domain, int type, int protocol);
338 * Reset FD set (clears all file descriptors).
340 * @param fds fd set to clear
343 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
347 * Add a socket to the FD set
349 * @param desc socket to add
352 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
353 const struct GNUNET_NETWORK_Handle *desc);
358 * Add a W32 file handle to the fd set
360 * @param h the file handle to add
363 GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet
369 * Check whether a socket is part of the fd set
372 * @return GNUNET_YES if the socket is in the set
375 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
376 const struct GNUNET_NETWORK_Handle *desc);
380 * Add one fd set to another
381 * @param dst the fd set to add to
382 * @param src the fd set to add from
385 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
386 const struct GNUNET_NETWORK_FDSet *src);
390 * Copy one fd set to another
391 * @param to destination
395 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
396 const struct GNUNET_NETWORK_FDSet *from);
400 * Return file descriptor for this network handle
402 * @param desc wrapper to process
403 * @return POSIX file descriptor
406 GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc);
410 * Return the sockaddr for this network handle
412 * @param desc wrapper to process
413 * @return POSIX file descriptor
416 GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc);
420 * Return sockaddr length for this network handle
422 * @param desc wrapper to process
423 * @return socklen_t for sockaddr
426 GNUNET_NETWORK_get_addrlen (struct GNUNET_NETWORK_Handle *desc);
430 * Copy a native fd set
431 * @param to destination
432 * @param from native source set
433 * @param nfds the biggest socket number in from + 1
436 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
437 const fd_set * from, int nfds);
441 * Set a native fd in a set
443 * @param to destination
444 * @param nfd native FD to set
447 GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd);
451 * Test native fd in a set
453 * @param to set to test, NULL for empty set
454 * @param nfd native FD to test, -1 for none
455 * @return GNUNET_YES if to contains nfd
458 GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
463 * Add a file handle to the fd set
465 * @param h the file handle to add
468 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
469 const struct GNUNET_DISK_FileHandle *h);
473 * Check if a file handle is part of an fd set
475 * @param h file handle
476 * @return GNUNET_YES if the file handle is part of the set
479 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
480 const struct GNUNET_DISK_FileHandle *h);
484 * Checks if two fd sets overlap
485 * @param fds1 first fd set
486 * @param fds2 second fd set
487 * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
490 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
491 const struct GNUNET_NETWORK_FDSet *fds2);
496 * @return a new fd set
498 struct GNUNET_NETWORK_FDSet *
499 GNUNET_NETWORK_fdset_create (void);
503 * Releases the associated memory of an fd set
507 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
510 #if 0 /* keep Emacsens' auto-indent happy */
517 #endif /* GNUNET_NETWORK_LIB_H */