X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_network_lib.h;h=9e692bbbf6c21eacfe536a845e98e9f20328306a;hb=4e084e4842cddf5de988534c84e2d65bb122472f;hp=a6cadedea526a5cb752b599e72c837287f8851fd;hpb=dfe50afe2bf4365ca66cce552bf8048751f7fcca;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_network_lib.h b/src/include/gnunet_network_lib.h index a6cadedea..9e692bbbf 100644 --- a/src/include/gnunet_network_lib.h +++ b/src/include/gnunet_network_lib.h @@ -1,10 +1,10 @@ /* This file is part of GNUnet. - (C) 2009 Christian Grothoff (and other contributing authors) + Copyright (C) 2009-2013 GNUnet e.V. GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 2, or (at your + by the Free Software Foundation; either version 3, or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but @@ -14,16 +14,20 @@ You should have received a copy of the GNU General Public License along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_network_lib.h - * @brief basic low-level networking interface * @author Nils Durner + * + * @file + * Basic low-level networking interface + * + * @defgroup network Network library + * Basic low-level networking interface + * @{ */ - #ifndef GNUNET_NETWORK_LIB_H #define GNUNET_NETWORK_LIB_H @@ -60,9 +64,23 @@ struct GNUNET_NETWORK_FDSet #ifdef WINDOWS /** - * Linked list of handles + * Array of file handles (from pipes) that are also in + * the FDSet. Needed as those cannot go into @e sds + * on W32. + */ + const struct GNUNET_DISK_FileHandle **handles; + + /** + * Size of the @e handles array */ - struct GNUNET_CONTAINER_SList *handles; + unsigned int handles_size; + + /** + * Number of @e handles slots in use. Always + * smaller than @e handles_size. + */ + unsigned int handles_pos; + #endif }; @@ -74,7 +92,7 @@ struct GNUNET_NETWORK_FDSet * Test if the given protocol family is supported by this system. * * @param pf protocol family to test (PF_INET, PF_INET6, PF_UNIX) - * @return GNUNET_OK if the PF is supported + * @return #GNUNET_OK if the PF is supported */ int GNUNET_NETWORK_test_pf (int pf); @@ -93,6 +111,21 @@ char * GNUNET_NETWORK_shorten_unixpath (char *unixpath); +#ifndef WINDOWS +/** + * If services crash, they can leave a unix domain socket file on the + * disk. This needs to be manually removed, because otherwise both + * bind() and connect() for the respective address will fail. In this + * function, we test if such a left-over file exists, and if so, + * remove it (unless there is a listening service at the address). + * + * @param un unix domain socket address to check + */ +void +GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un); +#endif + + /** * Accept a new connection on a socket. Configure it for non-blocking * IO and mark it as non-inheritable to child processes (set the @@ -106,7 +139,7 @@ GNUNET_NETWORK_shorten_unixpath (char *unixpath); struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc, struct sockaddr *address, - socklen_t * address_len); + socklen_t *address_len); /** @@ -124,51 +157,52 @@ GNUNET_NETWORK_socket_box_native (SOCKTYPE fd); * * @param fd socket * @param doBlock blocking mode - * @return GNUNET_OK on success, GNUNET_SYSERR on error + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int -GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, +GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, int doBlock); /** - * Fail to bind if an address is already in use. - */ -#define GNUNET_BIND_EXCLUSIVE 0x01 - - -/** - * Bind to a connected socket + * Bind a socket to a particular address. * * @param desc socket to bind * @param address address to be bound - * @param address_len length of address - * @param flags flags affecting bind behaviour - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @param address_len length of @a address + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, - socklen_t address_len, - int flags); + socklen_t address_len); /** * Close a socket. * * @param desc socket to close - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc); /** - * Connect a socket + * Only free memory of a socket, keep the file descriptor untouched. + * + * @param desc socket + */ +void +GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc); + + +/** + * Connect a socket to some remote address. * * @param desc socket to connect * @param address peer address - * @param address_len of address - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @param address_len of @a address + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc, @@ -184,12 +218,14 @@ GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc, * @param optname identifier of the option * @param optval options * @param optlen length of optval - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc, - int level, int optname, void *optval, - socklen_t * optlen); + int level, + int optname, + void *optval, + socklen_t *optlen); /** @@ -197,7 +233,7 @@ GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc, * * @param desc socket to start listening on * @param backlog length of the listen queue - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc, @@ -206,15 +242,17 @@ GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc, /** * How much data is available to be read on this descriptor? + * * @param desc socket + * @returns #GNUNET_SYSERR if no data is available, or on error! */ ssize_t -GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle - *desc); +GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc); /** - * Read data from a connected socket (always non-blocking). + * Read data from a socket (always non-blocking). + * * @param desc socket * @param buffer buffer * @param length length of buffer @@ -224,8 +262,10 @@ GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle */ ssize_t GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc, - void *buffer, size_t length, - struct sockaddr *src_addr, socklen_t *addrlen); + void *buffer, + size_t length, + struct sockaddr *src_addr, + socklen_t *addrlen); /** @@ -238,16 +278,18 @@ GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc, */ ssize_t GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, - void *buffer, size_t length); + void *buffer, + size_t length); /** - * Check if sockets meet certain conditions + * Check if sockets meet certain conditions. + * * @param rfds set of sockets to be checked for readability * @param wfds set of sockets to be checked for writability * @param efds set of sockets to be checked for exceptions * @param timeout relative value when to return - * @return number of selected sockets, GNUNET_SYSERR on error + * @return number of selected sockets, #GNUNET_SYSERR on error */ int GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds, @@ -262,11 +304,12 @@ GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds, * @param desc socket * @param buffer data to send * @param length size of the buffer - * @return number of bytes sent, GNUNET_SYSERR on error + * @return number of bytes sent, #GNUNET_SYSERR on error */ ssize_t GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, - const void *buffer, size_t length); + const void *buffer, + size_t length); /** @@ -275,14 +318,15 @@ GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, * * @param desc socket * @param message data to send - * @param length size of the data + * @param length size of the data in @a message * @param dest_addr destination address - * @param dest_len length of address - * @return number of bytes sent, GNUNET_SYSERR on error + * @param dest_len length of @a dest_addr + * @return number of bytes sent, #GNUNET_SYSERR on error */ ssize_t GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc, - const void *message, size_t length, + const void *message, + size_t length, const struct sockaddr *dest_addr, socklen_t dest_len); @@ -294,12 +338,14 @@ GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc, * @param level protocol level of the option * @param option_name option identifier * @param option_value value to set - * @param option_len size of option_value - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @param option_len size of @a option_value + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int -GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level, - int option_name, const void *option_value, +GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, + int level, + int option_name, + const void *option_value, socklen_t option_len); @@ -308,10 +354,11 @@ GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level, * * @param desc socket * @param how type of shutdown - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int -GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how); +GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, + int how); /** @@ -321,7 +368,7 @@ GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how); * reduces the OS send buffers to zero. * * @param desc socket - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ int GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc); @@ -338,7 +385,9 @@ GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc); * @return new socket, NULL on error */ struct GNUNET_NETWORK_Handle * -GNUNET_NETWORK_socket_create (int domain, int type, int protocol); +GNUNET_NETWORK_socket_create (int domain, + int type, + int protocol); /** @@ -352,6 +401,7 @@ GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds); /** * Add a socket to the FD set + * * @param fds fd set * @param desc socket to add */ @@ -363,20 +413,22 @@ GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds, #if WINDOWS /** * Add a W32 file handle to the fd set + * * @param fds fd set * @param h the file handle to add */ void -GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet - *fds, HANDLE h); +GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet *fds, + HANDLE h); #endif /** * Check whether a socket is part of the fd set + * * @param fds fd set * @param desc socket - * @return GNUNET_YES if the socket is in the set + * @return #GNUNET_YES if the socket is in the set */ int GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds, @@ -384,7 +436,8 @@ GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds, /** - * Add one fd set to another + * Add one fd set to another (computes the union). + * * @param dst the fd set to add to * @param src the fd set to add from */ @@ -395,6 +448,7 @@ GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst, /** * Copy one fd set to another + * * @param to destination * @param from source */ @@ -410,7 +464,7 @@ GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to, * @return POSIX file descriptor */ int -GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc); +GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc); /** @@ -420,7 +474,7 @@ GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc); * @return POSIX file descriptor */ struct sockaddr* -GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc); +GNUNET_NETWORK_get_addr (const struct GNUNET_NETWORK_Handle *desc); /** @@ -430,18 +484,20 @@ GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc); * @return socklen_t for sockaddr */ socklen_t -GNUNET_NETWORK_get_addrlen (struct GNUNET_NETWORK_Handle *desc); +GNUNET_NETWORK_get_addrlen (const struct GNUNET_NETWORK_Handle *desc); /** - * Copy a native fd set + * Copy a native fd set into the GNUnet representation. + * * @param to destination * @param from native source set * @param nfds the biggest socket number in from + 1 */ void GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to, - const fd_set * from, int nfds); + const fd_set *from, + int nfds); /** @@ -451,7 +507,8 @@ GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to, * @param nfd native FD to set */ void -GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd); +GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, + int nfd); /** @@ -459,7 +516,7 @@ GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd); * * @param to set to test, NULL for empty set * @param nfd native FD to test, -1 for none - * @return GNUNET_YES if to contains nfd + * @return #GNUNET_YES if to contains nfd */ int GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to, @@ -468,6 +525,7 @@ GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to, /** * Add a file handle to the fd set + * * @param fds fd set * @param h the file handle to add */ @@ -476,11 +534,24 @@ GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h); +/** + * Add a file handle to the fd set + * On W32: ensure that the handle is first in the array. + * + * @param fds fd set + * @param h the file handle to add + */ +void +GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_DISK_FileHandle *h); + + /** * Check if a file handle is part of an fd set + * * @param fds fd set * @param h file handle - * @return GNUNET_YES if the file handle is part of the set + * @return #GNUNET_YES if the file handle is part of the set */ int GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds, @@ -489,9 +560,10 @@ GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds, /** * Checks if two fd sets overlap + * * @param fds1 first fd set * @param fds2 second fd set - * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise + * @return #GNUNET_YES if they do overlap, #GNUNET_NO otherwise */ int GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1, @@ -500,6 +572,7 @@ GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1, /** * Creates an fd set + * * @return a new fd set */ struct GNUNET_NETWORK_FDSet * @@ -508,12 +581,25 @@ GNUNET_NETWORK_fdset_create (void); /** * Releases the associated memory of an fd set + * * @param fds fd set */ void GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); +/** + * Test if the given @a port is available. + * + * @param ipproto transport protocol to test (i.e. IPPROTO_TCP) + * @param port port number to test + * @return #GNUNET_OK if the port is available, #GNUNET_NO if not + */ +int +GNUNET_NETWORK_test_port_free (int ipproto, + uint16_t port); + + #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -522,3 +608,5 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); #endif #endif /* GNUNET_NETWORK_LIB_H */ + +/** @} */ /* end of group */