uncrustify as demanded.
[oweals/gnunet.git] / src / include / gnunet_network_lib.h
index 6c02f3577193f5ef54a2edef33b1f7317fe9f04d..2a91621a3d95ba1eee5983643149d425c62985dc 100644 (file)
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Affero General Public License for more details.
-    
+
      You should have received a copy of the GNU Affero General Public License
      along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
      SPDX-License-Identifier: AGPL3.0-or-later
-*/
+ */
 
 /**
  * @author Nils Durner
@@ -49,9 +49,7 @@ struct GNUNET_NETWORK_Handle;
 /**
  * @brief collection of IO descriptors
  */
-struct GNUNET_NETWORK_FDSet
-{
-
+struct GNUNET_NETWORK_FDSet {
   /**
    * Maximum number of any socket descriptor in the set (plus one)
    */
@@ -80,9 +78,7 @@ struct GNUNET_NETWORK_FDSet
    * smaller than @e handles_size.
    */
   unsigned int handles_pos;
-
 #endif
-
 };
 
 #include "gnunet_disk_lib.h"
@@ -95,7 +91,7 @@ struct GNUNET_NETWORK_FDSet
  * @return #GNUNET_OK if the PF is supported
  */
 int
-GNUNET_NETWORK_test_pf (int pf);
+GNUNET_NETWORK_test_pf(int pf);
 
 
 /**
@@ -108,7 +104,7 @@ GNUNET_NETWORK_test_pf (int pf);
  * @return shortened unixpath, NULL on error
  */
 char *
-GNUNET_NETWORK_shorten_unixpath (char *unixpath);
+GNUNET_NETWORK_shorten_unixpath(char *unixpath);
 
 
 #ifndef WINDOWS
@@ -122,7 +118,7 @@ GNUNET_NETWORK_shorten_unixpath (char *unixpath);
  * @param un unix domain socket address to check
  */
 void
-GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un);
+GNUNET_NETWORK_unix_precheck(const struct sockaddr_un *un);
 #endif
 
 
@@ -137,9 +133,9 @@ GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un);
  * @return client socket
  */
 struct GNUNET_NETWORK_Handle *
-GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
-                              struct sockaddr *address,
-                              socklen_t *address_len);
+GNUNET_NETWORK_socket_accept(const struct GNUNET_NETWORK_Handle *desc,
+                             struct sockaddr *address,
+                             socklen_t *address_len);
 
 
 /**
@@ -149,7 +145,7 @@ GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
  * @return NULL on error (including not supported on target platform)
  */
 struct GNUNET_NETWORK_Handle *
-GNUNET_NETWORK_socket_box_native (SOCKTYPE fd);
+GNUNET_NETWORK_socket_box_native(SOCKTYPE fd);
 
 
 /**
@@ -160,8 +156,8 @@ GNUNET_NETWORK_socket_box_native (SOCKTYPE fd);
  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 int
-GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
-                                   int doBlock);
+GNUNET_NETWORK_socket_set_blocking(struct GNUNET_NETWORK_Handle *fd,
+                                   int doBlock);
 
 
 /**
@@ -173,9 +169,9 @@ GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
  * @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);
+GNUNET_NETWORK_socket_bind(struct GNUNET_NETWORK_Handle *desc,
+                           const struct sockaddr *address,
+                           socklen_t address_len);
 
 /**
  * Close a socket.
@@ -184,7 +180,7 @@ GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
  */
 int
-GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -193,7 +189,7 @@ GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
  * @param desc socket
  */
 void
-GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_socket_free_memory_only_(struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -205,9 +201,9 @@ GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc);
  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
  */
 int
-GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
-                               const struct sockaddr *address,
-                               socklen_t address_len);
+GNUNET_NETWORK_socket_connect(const struct GNUNET_NETWORK_Handle *desc,
+                              const struct sockaddr *address,
+                              socklen_t address_len);
 
 
 /**
@@ -221,11 +217,11 @@ GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
  * @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);
+GNUNET_NETWORK_socket_getsockopt(const struct GNUNET_NETWORK_Handle *desc,
+                                 int level,
+                                 int optname,
+                                 void *optval,
+                                 socklen_t *optlen);
 
 
 /**
@@ -236,8 +232,8 @@ GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
  */
 int
-GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
-                              int backlog);
+GNUNET_NETWORK_socket_listen(const struct GNUNET_NETWORK_Handle *desc,
+                             int backlog);
 
 
 /**
@@ -247,7 +243,7 @@ GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
  * @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);
 
 
 /**
@@ -261,11 +257,11 @@ GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc)
  * @param addrlen length of the addr
  */
 ssize_t
-GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
-                                void *buffer,
-                                size_t length,
-                                struct sockaddr *src_addr,
-                                socklen_t *addrlen);
+GNUNET_NETWORK_socket_recvfrom(const struct GNUNET_NETWORK_Handle *desc,
+                               void *buffer,
+                               size_t length,
+                               struct sockaddr *src_addr,
+                               socklen_t *addrlen);
 
 
 /**
@@ -277,9 +273,9 @@ GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
  * @return number of bytes read
  */
 ssize_t
-GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
-                            void *buffer,
-                            size_t length);
+GNUNET_NETWORK_socket_recv(const struct GNUNET_NETWORK_Handle *desc,
+                           void *buffer,
+                           size_t length);
 
 
 /**
@@ -292,10 +288,10 @@ GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
  * @return number of selected sockets, #GNUNET_SYSERR on error
  */
 int
-GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
-                              struct GNUNET_NETWORK_FDSet *wfds,
-                              struct GNUNET_NETWORK_FDSet *efds,
-                              struct GNUNET_TIME_Relative timeout);
+GNUNET_NETWORK_socket_select(struct GNUNET_NETWORK_FDSet *rfds,
+                             struct GNUNET_NETWORK_FDSet *wfds,
+                             struct GNUNET_NETWORK_FDSet *efds,
+                             struct GNUNET_TIME_Relative timeout);
 
 
 /**
@@ -307,9 +303,9 @@ GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
  * @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);
+GNUNET_NETWORK_socket_send(const struct GNUNET_NETWORK_Handle *desc,
+                           const void *buffer,
+                           size_t length);
 
 
 /**
@@ -324,11 +320,11 @@ GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
  * @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 struct sockaddr *dest_addr,
-                              socklen_t dest_len);
+GNUNET_NETWORK_socket_sendto(const struct GNUNET_NETWORK_Handle *desc,
+                             const void *message,
+                             size_t length,
+                             const struct sockaddr *dest_addr,
+                             socklen_t dest_len);
 
 
 /**
@@ -342,11 +338,11 @@ GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
  * @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,
-                                  socklen_t option_len);
+GNUNET_NETWORK_socket_setsockopt(struct GNUNET_NETWORK_Handle *fd,
+                                 int level,
+                                 int option_name,
+                                 const void *option_value,
+                                 socklen_t option_len);
 
 
 /**
@@ -357,8 +353,8 @@ GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
  * @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);
 
 
 /**
@@ -371,7 +367,7 @@ GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
  */
 int
-GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_socket_disable_corking(struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -385,9 +381,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);
 
 
 /**
@@ -396,7 +392,7 @@ GNUNET_NETWORK_socket_create (int domain,
  * @param fds fd set to clear
  */
 void
-GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
+GNUNET_NETWORK_fdset_zero(struct GNUNET_NETWORK_FDSet *fds);
 
 
 /**
@@ -406,8 +402,8 @@ GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
  * @param desc socket to add
  */
 void
-GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
-                          const struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_fdset_set(struct GNUNET_NETWORK_FDSet *fds,
+                         const struct GNUNET_NETWORK_Handle *desc);
 
 
 #if WINDOWS
@@ -418,8 +414,8 @@ GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
  * @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
 
 
@@ -431,8 +427,8 @@ GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet *
  * @return #GNUNET_YES if the socket is in the set
  */
 int
-GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
-                            const struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_fdset_isset(const struct GNUNET_NETWORK_FDSet *fds,
+                           const struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -442,8 +438,8 @@ GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
  * @param src the fd set to add from
  */
 void
-GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
-                          const struct GNUNET_NETWORK_FDSet *src);
+GNUNET_NETWORK_fdset_add(struct GNUNET_NETWORK_FDSet *dst,
+                         const struct GNUNET_NETWORK_FDSet *src);
 
 
 /**
@@ -453,8 +449,8 @@ GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
  * @param from source
  */
 void
-GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
-                           const struct GNUNET_NETWORK_FDSet *from);
+GNUNET_NETWORK_fdset_copy(struct GNUNET_NETWORK_FDSet *to,
+                          const struct GNUNET_NETWORK_FDSet *from);
 
 
 /**
@@ -464,7 +460,7 @@ GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
  * @return POSIX file descriptor
  */
 int
-GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_get_fd(const struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -474,7 +470,7 @@ GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc);
  * @return POSIX file descriptor
  */
 struct sockaddr*
-GNUNET_NETWORK_get_addr (const struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_get_addr(const struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -484,7 +480,7 @@ GNUNET_NETWORK_get_addr (const struct GNUNET_NETWORK_Handle *desc);
  * @return socklen_t for sockaddr
  */
 socklen_t
-GNUNET_NETWORK_get_addrlen (const struct GNUNET_NETWORK_Handle *desc);
+GNUNET_NETWORK_get_addrlen(const struct GNUNET_NETWORK_Handle *desc);
 
 
 /**
@@ -495,9 +491,9 @@ GNUNET_NETWORK_get_addrlen (const struct GNUNET_NETWORK_Handle *desc);
  * @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);
+GNUNET_NETWORK_fdset_copy_native(struct GNUNET_NETWORK_FDSet *to,
+                                 const fd_set *from,
+                                 int nfds);
 
 
 /**
@@ -507,8 +503,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);
 
 
 /**
@@ -519,8 +515,8 @@ GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to,
  * @return #GNUNET_YES if to contains nfd
  */
 int
-GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
-                                  int nfd);
+GNUNET_NETWORK_fdset_test_native(const struct GNUNET_NETWORK_FDSet *to,
+                                 int nfd);
 
 
 /**
@@ -530,8 +526,8 @@ GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
  * @param h the file handle to add
  */
 void
-GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
-                                 const struct GNUNET_DISK_FileHandle *h);
+GNUNET_NETWORK_fdset_handle_set(struct GNUNET_NETWORK_FDSet *fds,
+                                const struct GNUNET_DISK_FileHandle *h);
 
 
 /**
@@ -542,8 +538,8 @@ GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
  * @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);
+GNUNET_NETWORK_fdset_handle_set_first(struct GNUNET_NETWORK_FDSet *fds,
+                                      const struct GNUNET_DISK_FileHandle *h);
 
 
 /**
@@ -554,8 +550,8 @@ GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds,
  * @return #GNUNET_YES if the file handle is part of the set
  */
 int
-GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
-                                   const struct GNUNET_DISK_FileHandle *h);
+GNUNET_NETWORK_fdset_handle_isset(const struct GNUNET_NETWORK_FDSet *fds,
+                                  const struct GNUNET_DISK_FileHandle *h);
 
 
 /**
@@ -566,8 +562,8 @@ GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
  * @return #GNUNET_YES if they do overlap, #GNUNET_NO otherwise
  */
 int
-GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
-                              const struct GNUNET_NETWORK_FDSet *fds2);
+GNUNET_NETWORK_fdset_overlap(const struct GNUNET_NETWORK_FDSet *fds1,
+                             const struct GNUNET_NETWORK_FDSet *fds2);
 
 
 /**
@@ -576,7 +572,7 @@ GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
  * @return a new fd set
  */
 struct GNUNET_NETWORK_FDSet *
-GNUNET_NETWORK_fdset_create (void);
+GNUNET_NETWORK_fdset_create(void);
 
 
 /**
@@ -585,7 +581,7 @@ GNUNET_NETWORK_fdset_create (void);
  * @param fds fd set
  */
 void
-GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
+GNUNET_NETWORK_fdset_destroy(struct GNUNET_NETWORK_FDSet *fds);
 
 
 /**
@@ -596,8 +592,8 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
  * @return #GNUNET_OK if the port is available, #GNUNET_NO if not
  */
 int
-GNUNET_NETWORK_test_port_free (int ipproto,
-                              uint16_t port);
+GNUNET_NETWORK_test_port_free(int ipproto,
+                              uint16_t port);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */