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 * Bind to a connected socket
126 * @param desc socket to bind
127 * @param address address to be bound
128 * @param address_len length of address
129 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
132 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
133 const struct sockaddr *address,
134 socklen_t address_len);
139 * @param desc socket to close
140 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
143 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
149 * @param desc socket to connect
150 * @param address peer address
151 * @param address_len of address
152 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
155 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
156 const struct sockaddr *address,
157 socklen_t address_len);
163 * @param desc socket to inspect
164 * @param level protocol level of the option
165 * @param optname identifier of the option
166 * @param optval options
167 * @param optlen length of optval
168 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
171 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
172 int level, int optname, void *optval,
179 * @param desc socket to start listening on
180 * @param backlog length of the listen queue
181 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
184 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
189 * How much data is available to be read on this descriptor?
193 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle
198 * Read data from a connected socket (always non-blocking).
200 * @param buffer buffer
201 * @param length length of buffer
202 * @param src_addr either the source to recv from, or all zeroes
203 * to be filled in by recvfrom
204 * @param addrlen length of the addr
207 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
208 void *buffer, size_t length,
209 struct sockaddr *src_addr, socklen_t *addrlen);
213 * Read data from a connected socket (always non-blocking).
216 * @param buffer buffer
217 * @param length length of buffer
218 * @return number of bytes read
221 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
222 void *buffer, size_t length);
226 * Check if sockets meet certain conditions
227 * @param rfds set of sockets to be checked for readability
228 * @param wfds set of sockets to be checked for writability
229 * @param efds set of sockets to be checked for exceptions
230 * @param timeout relative value when to return
231 * @return number of selected sockets, GNUNET_SYSERR on error
234 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
235 struct GNUNET_NETWORK_FDSet *wfds,
236 struct GNUNET_NETWORK_FDSet *efds,
237 struct GNUNET_TIME_Relative timeout);
241 * Send data (always non-blocking).
244 * @param buffer data to send
245 * @param length size of the buffer
246 * @return number of bytes sent, GNUNET_SYSERR on error
249 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
250 const void *buffer, size_t length);
254 * Send data to a particular destination (always non-blocking).
255 * This function only works for UDP sockets.
258 * @param message data to send
259 * @param length size of the data
260 * @param dest_addr destination address
261 * @param dest_len length of address
262 * @return number of bytes sent, GNUNET_SYSERR on error
265 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
266 const void *message, size_t length,
267 const struct sockaddr *dest_addr,
275 * @param level protocol level of the option
276 * @param option_name option identifier
277 * @param option_value value to set
278 * @param option_len size of option_value
279 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
282 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level,
283 int option_name, const void *option_value,
284 socklen_t option_len);
288 * Shut down socket operations
291 * @param how type of shutdown
292 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
295 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how);
299 * Disable the "CORK" feature for communication with the given socket,
300 * forcing the OS to immediately flush the buffer on transmission
301 * instead of potentially buffering multiple messages. Essentially
302 * reduces the OS send buffers to zero.
305 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
308 GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc);
312 * Create a new socket. Configure it for non-blocking IO and
313 * mark it as non-inheritable to child processes (set the
314 * close-on-exec flag).
316 * @param domain domain of the socket
317 * @param type socket type
318 * @param protocol network protocol
319 * @return new socket, NULL on error
321 struct GNUNET_NETWORK_Handle *
322 GNUNET_NETWORK_socket_create (int domain, int type, int protocol);
326 * Reset FD set (clears all file descriptors).
328 * @param fds fd set to clear
331 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
335 * Add a socket to the FD set
337 * @param desc socket to add
340 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
341 const struct GNUNET_NETWORK_Handle *desc);
346 * Add a W32 file handle to the fd set
348 * @param h the file handle to add
351 GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet
357 * Check whether a socket is part of the fd set
360 * @return GNUNET_YES if the socket is in the set
363 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
364 const struct GNUNET_NETWORK_Handle *desc);
368 * Add one fd set to another
369 * @param dst the fd set to add to
370 * @param src the fd set to add from
373 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
374 const struct GNUNET_NETWORK_FDSet *src);
378 * Copy one fd set to another
379 * @param to destination
383 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
384 const struct GNUNET_NETWORK_FDSet *from);
388 * Return file descriptor for this network handle
390 * @param desc wrapper to process
391 * @return POSIX file descriptor
394 GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc);
398 * Return the sockaddr for this network handle
400 * @param desc wrapper to process
401 * @return POSIX file descriptor
404 GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc);
408 * Return sockaddr length for this network handle
410 * @param desc wrapper to process
411 * @return socklen_t for sockaddr
414 GNUNET_NETWORK_get_addrlen (struct GNUNET_NETWORK_Handle *desc);
418 * Copy a native fd set
419 * @param to destination
420 * @param from native source set
421 * @param nfds the biggest socket number in from + 1
424 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
425 const fd_set * from, int nfds);
429 * Set a native fd in a set
431 * @param to destination
432 * @param nfd native FD to set
435 GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd);
439 * Test native fd in a set
441 * @param to set to test, NULL for empty set
442 * @param nfd native FD to test, -1 for none
443 * @return GNUNET_YES if to contains nfd
446 GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
451 * Add a file handle to the fd set
453 * @param h the file handle to add
456 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
457 const struct GNUNET_DISK_FileHandle *h);
461 * Check if a file handle is part of an fd set
463 * @param h file handle
464 * @return GNUNET_YES if the file handle is part of the set
467 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
468 const struct GNUNET_DISK_FileHandle *h);
472 * Checks if two fd sets overlap
473 * @param fds1 first fd set
474 * @param fds2 second fd set
475 * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
478 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
479 const struct GNUNET_NETWORK_FDSet *fds2);
484 * @return a new fd set
486 struct GNUNET_NETWORK_FDSet *
487 GNUNET_NETWORK_fdset_create (void);
491 * Releases the associated memory of an fd set
495 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
498 #if 0 /* keep Emacsens' auto-indent happy */
505 #endif /* GNUNET_NETWORK_LIB_H */