docs & GNUnet-style return codes
authorNils Durner <durner@gnunet.org>
Sun, 30 Aug 2009 21:06:23 +0000 (21:06 +0000)
committerNils Durner <durner@gnunet.org>
Sun, 30 Aug 2009 21:06:23 +0000 (21:06 +0000)
src/include/gnunet_network_lib.h
src/util/connection.c
src/util/network.c
src/util/server.c
src/util/service.c
src/util/test_connection.c
src/util/test_connection_addressing.c
src/util/test_connection_receive_cancel.c
src/util/test_connection_timeout.c
src/util/test_service.c

index b475ff4f042769989bb448e53f4e195141af843d..97fcf2618761761b76b3af7e178f760742d23206 100644 (file)
@@ -51,93 +51,243 @@ struct GNUNET_NETWORK_FDSet;
 #include "gnunet_disk_lib.h"
 #include "gnunet_time_lib.h"
 
-
+/**
+ * accept a new connection on a socket
+ *
+ * @param desc bound socket
+ * @param address address of the connecting peer, may be NULL
+ * @param address_len length of address
+ * @return client socket
+ */
 struct GNUNET_NETWORK_Handle *
 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
                              struct sockaddr *address,
                              socklen_t *address_len);
 
+/**
+ * Make a non-inheritable to child processes
+ * @param socket
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ * @warning Not implemented on Windows
+ */
 int
 GNUNET_NETWORK_socket_set_inheritable (const struct GNUNET_NETWORK_Handle
                                        *desc);
 
-
+/**
+ * Bind to a connected socket
+ * @param desc socket
+ * @param address address to be bound
+ * @param address_len length of 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);
 
+/**
+ * Close a socket
+ * @param desc socket
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ */
 int GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
 
+/**
+ * Connect a socket
+ * @param desc socket
+ * @param address peer address
+ * @param length of address
+ * @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);
 
+/**
+ * Get socket options
+ * @param desc socket
+ * @param level protocol level of the option
+ * @param optname identifier of the option
+ * @param optval options
+ * @param optlen length of optval
+ * @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);
 
+/**
+ * Listen on a socket
+ * @param desc socket
+ * @param backlog length of the listen queue
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ */
 int GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc, int backlog);
 
-ssize_t GNUNET_NETWORK_socket_read (const struct GNUNET_NETWORK_Handle *desc, void *buf,
-                        size_t nbyte);
-
+/**
+ * Read data from a connected socket
+ * @param desc socket
+ * @param buffer buffer
+ * @param length length of buffer
+ * @param flags type of message reception
+ */
 ssize_t GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, void *buffer,
                         size_t length, int flags);
 
+/**
+ * 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
+ */
 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);
 
 /**
  * Set if a socket should use blocking or non-blocking IO.
- *
+ * @param fd socket
+ * @param doBlock blocking mode
  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
 int GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, int doBlock);
 
+/**
+ * Send data
+ * @param desc socket
+ * @param buffer data to send
+ * @param length size of the buffer
+ * @param flags type of message transmission
+ * @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, int flags);
 
+/**
+ * Send data
+ * @param desc socket
+ * @param message data to send
+ * @param length size of the data
+ * @param flags type of message transmission
+ * @param dest_addr destination address
+ * @param dest_len length of address
+ * @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, int flags,
                           const struct sockaddr *dest_addr,
                           socklen_t dest_len);
 
+/**
+ * Set socket option
+ * @param fd socket
+ * @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
+ */
 int GNUNET_NETWORK_socket_setsockopt(struct GNUNET_NETWORK_Handle *fd, int level, int option_name,
        const void *option_value, socklen_t option_len);
 
+/**
+ * Shut down socket operations
+ * @param desc socket
+ * @param how type of shutdown
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ */
 int GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how);
 
+/**
+ * Create a new socket
+ * @param domain domain of the socket
+ * @param type socket type
+ * @param protocol network protocol
+ * @return new socket, NULL on error
+ */
 struct GNUNET_NETWORK_Handle *GNUNET_NETWORK_socket_socket (int domain, int type, int protocol);
 
-ssize_t GNUNET_NETWORK_socket_write (const struct GNUNET_NETWORK_Handle *desc,
-                         const void *buf, size_t nbyte);
-
-
+/**
+ * Reset FD set
+ * @param fds fd set
+ */
 void 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
+ */
 void GNUNET_NETWORK_fdset_set(struct GNUNET_NETWORK_FDSet *fds,
     const struct GNUNET_NETWORK_Handle *desc);
 
+/**
+ * Check whether a socket is part of the fd set
+ * @param fds fd set
+ * @param desc socket
+ */
 int GNUNET_NETWORK_fdset_isset(const struct GNUNET_NETWORK_FDSet *fds,
     const struct GNUNET_NETWORK_Handle *desc);
 
+/**
+ * Add one fd set to another
+ * @param dst the fd set to add to
+ * @param src the fd set to add from
+ */
 void GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
     const struct GNUNET_NETWORK_FDSet *src);
 
+/**
+ * Copy one fd set to another
+ * @param to destination
+ * @param from source
+ */
 void GNUNET_NETWORK_fdset_copy(struct GNUNET_NETWORK_FDSet *to,
     const struct GNUNET_NETWORK_FDSet *from);
 
+/**
+ * Copy a native fd set
+ * @param to destination
+ * @param from native source set
+ * @param the biggest socket number in from + 1
+ */
 void GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to, const fd_set *from,
     int nfds);
 
+/**
+ * Add a file handle to the fd set
+ * @param fds fd set
+ * @param h the file handle to add
+ */
 void GNUNET_NETWORK_fdset_handle_set (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
+ */
 int GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
     const struct GNUNET_DISK_FileHandle *h);
 
+/**
+ * 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
+ */
 int GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1, const struct GNUNET_NETWORK_FDSet *fds2);
 
+/**
+ * Creates an fd set
+ * @return a new fd set
+ */
 struct GNUNET_NETWORK_FDSet *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);
 
 
index 9ae72b2dc9960497f2c4009c4ade682bd50eb4ce..2e3a64370b3ab4c221b771e1e61790966948885a 100644 (file)
@@ -276,7 +276,7 @@ GNUNET_CONNECTION_create_from_accept (struct GNUNET_SCHEDULER_Handle
   if (addrlen > sizeof (addr))
     {
       GNUNET_break (0);
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
       return NULL;
     }
 
@@ -310,7 +310,7 @@ GNUNET_CONNECTION_create_from_accept (struct GNUNET_SCHEDULER_Handle
                    _("Access denied to `%s'\n"),
                    GNUNET_a2s(uaddr, addrlen));
       GNUNET_break (0 == GNUNET_NETWORK_socket_shutdown (sock, SHUT_RDWR));
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
       GNUNET_free (uaddr);
       return NULL;
     }
@@ -436,7 +436,7 @@ try_connect (struct GNUNET_CONNECTION_Handle *sock)
       if (GNUNET_SYSERR == GNUNET_NETWORK_socket_set_blocking (s, GNUNET_NO))
         {
           /* we'll treat this one as fatal */
-          GNUNET_break (0 == GNUNET_NETWORK_socket_close (s));
+          GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (s));
           return GNUNET_SYSERR;
         }
 #if DEBUG_CONNECTION
@@ -445,13 +445,13 @@ try_connect (struct GNUNET_CONNECTION_Handle *sock)
                  GNUNET_a2s(sock->ai_pos->ai_addr,
                             sock->ai_pos->ai_addrlen));
 #endif
-      if ((0 != GNUNET_NETWORK_socket_connect (s,
+      if ((GNUNET_OK != GNUNET_NETWORK_socket_connect (s,
                          sock->ai_pos->ai_addr,
                          sock->ai_pos->ai_addrlen)) && (errno != EINPROGRESS))
         {
           /* maybe refused / unsupported address, try next */
           GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "connect");
-          GNUNET_break (0 == GNUNET_NETWORK_socket_close (s));
+          GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (s));
           sock->ai_pos = sock->ai_pos->ai_next;
           continue;
         }
@@ -497,7 +497,7 @@ connect_continuation (void *cls,
                  GNUNET_a2s(sock->addr, sock->addrlen));
 #endif
       /* connect failed / timed out */
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock->sock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock->sock));
       sock->sock = NULL;
       if (GNUNET_SYSERR == try_connect (sock))
         {
@@ -619,7 +619,7 @@ GNUNET_CONNECTION_create_from_sockaddr (struct GNUNET_SCHEDULER_Handle
   if (GNUNET_SYSERR == GNUNET_NETWORK_socket_set_blocking (s, GNUNET_NO))
     {
       /* we'll treat this one as fatal */
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (s));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (s));
       return NULL;
     }
 #if DEBUG_CONNECTION
@@ -627,11 +627,11 @@ GNUNET_CONNECTION_create_from_sockaddr (struct GNUNET_SCHEDULER_Handle
              _("Trying to connect to `%s'\n"),
              GNUNET_a2s(serv_addr, addrlen));
 #endif
-  if ((0 != GNUNET_NETWORK_socket_connect (s, serv_addr, addrlen)) && (errno != EINPROGRESS))
+  if ((GNUNET_OK != GNUNET_NETWORK_socket_connect (s, serv_addr, addrlen)) && (errno != EINPROGRESS))
     {
       /* maybe refused / unsupported address, try next */
       GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "connect");
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (s));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (s));
       return NULL;
     }
   ret = GNUNET_CONNECTION_create_from_existing (sched, s, maxbuf);
@@ -706,7 +706,7 @@ destroy_continuation (void *cls,
         }
     }
   if (sock->sock != NULL)
-    GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock->sock));
+    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock->sock));
   GNUNET_free_non_null (sock->addr);
   if (sock->ai != NULL)
     freeaddrinfo (sock->ai);      
@@ -1075,7 +1075,7 @@ transmit_ready (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
       if (NULL != sock->sock)
        {
          GNUNET_NETWORK_socket_shutdown (sock->sock, SHUT_RDWR);
-         GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock->sock));
+         GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock->sock));
          sock->sock = NULL;
        }
       transmit_error (sock);
@@ -1115,7 +1115,7 @@ RETRY:
       GNUNET_log_strerror (GNUNET_ERROR_TYPE_DEBUG, "send");
 #endif
       GNUNET_NETWORK_socket_shutdown (sock->sock, SHUT_RDWR);
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock->sock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock->sock));
       sock->sock = NULL;
       transmit_error (sock);
       return;
index ebf32910240b28e51322b853a40e3ac10ec8f9ee..ce3f7b40b12265143858fd9f038b4d3c29319aae 100644 (file)
@@ -51,6 +51,14 @@ struct GNUNET_NETWORK_FDSet
 #define FD_COPY(s, d) (memcpy ((d), (s), sizeof (fd_set)))\r
 #endif\r
 \r
+/**\r
+ * accept a new connection on a socket\r
+ *\r
+ * @param desc bound socket\r
+ * @param address address of the connecting peer, may be NULL\r
+ * @param address_len length of address\r
+ * @return client socket\r
+ */\r
 struct GNUNET_NETWORK_Handle *\r
 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,\r
                               struct sockaddr *address,\r
@@ -67,6 +75,13 @@ GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
   return ret;\r
 }\r
 \r
+/**\r
+ * Bind to a connected socket\r
+ * @param desc socket\r
+ * @param address address to be bound\r
+ * @param address_len length of address\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,\r
                             const struct sockaddr *address,\r
@@ -79,12 +94,13 @@ GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
   if (SOCKET_ERROR == ret)\r
     SetErrnoFromWinsockError (WSAGetLastError ());\r
 #endif\r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
 /**\r
  * Set if a socket should use blocking or non-blocking IO.\r
- *\r
+ * @param fd socket\r
+ * @param doBlock blocking mode\r
  * @return GNUNET_OK on success, GNUNET_SYSERR on error\r
  */\r
 int\r
@@ -123,6 +139,11 @@ GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
 #endif\r
 }\r
 \r
+/**\r
+ * Close a socket\r
+ * @param desc socket\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)\r
 {\r
@@ -141,9 +162,16 @@ GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)
     }\r
 #endif\r
 \r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
+/**\r
+ * Connect a socket\r
+ * @param desc socket\r
+ * @param address peer address\r
+ * @param length of address\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,\r
                                const struct sockaddr *address,\r
@@ -156,9 +184,18 @@ GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
   if (SOCKET_ERROR == ret)\r
     SetErrnoFromWinsockError (WSAGetLastError ());\r
 #endif\r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
+/**\r
+ * Get socket options\r
+ * @param desc socket\r
+ * @param level protocol level of the option\r
+ * @param optname identifier of the option\r
+ * @param optval options\r
+ * @param optlen length of optval\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,\r
                                   int level, int optname, void *optval,\r
@@ -173,9 +210,15 @@ GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
   else if (SOCKET_ERROR == ret)\r
     SetErrnoFromWinsockError (WSAGetLastError ());\r
 #endif\r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
+/**\r
+ * Listen on a socket\r
+ * @param desc socket\r
+ * @param backlog length of the listen queue\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,\r
                               int backlog)\r
@@ -188,9 +231,16 @@ GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
     SetErrnoFromWinsockError (WSAGetLastError ());\r
 #endif\r
 \r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
+/**\r
+ * Read data from a connected socket\r
+ * @param desc socket\r
+ * @param buffer buffer\r
+ * @param length length of buffer\r
+ * @param flags type of message reception\r
+ */\r
 ssize_t\r
 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle * desc,\r
                             void *buffer, size_t length, int flags)\r
@@ -206,6 +256,14 @@ GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle * desc,
   return ret;\r
 }\r
 \r
+/**\r
+ * Send data\r
+ * @param desc socket\r
+ * @param buffer data to send\r
+ * @param length size of the buffer\r
+ * @param flags type of message transmission\r
+ * @return number of bytes sent, GNUNET_SYSERR on error\r
+ */\r
 ssize_t\r
 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle * desc,\r
                             const void *buffer, size_t length, int flags)\r
@@ -221,6 +279,16 @@ GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle * desc,
   return ret;\r
 }\r
 \r
+/**\r
+ * Send data\r
+ * @param desc socket\r
+ * @param message data to send\r
+ * @param length size of the data\r
+ * @param flags type of message transmission\r
+ * @param dest_addr destination address\r
+ * @param dest_len length of address\r
+ * @return number of bytes sent, GNUNET_SYSERR on error\r
+ */\r
 ssize_t\r
 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle * desc,\r
                               const void *message, size_t length, int flags,\r
@@ -238,6 +306,15 @@ GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle * desc,
   return ret;\r
 }\r
 \r
+/**\r
+ * Set socket option\r
+ * @param fd socket\r
+ * @param level protocol level of the option\r
+ * @param option_name option identifier\r
+ * @param option_value value to set\r
+ * @param option_len size of option_value\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,\r
                                   int level, int option_name,\r
@@ -252,9 +329,16 @@ GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
     SetErrnoFromWinsockError (WSAGetLastError ());\r
 #endif\r
 \r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
+/**\r
+ * Create a new socket\r
+ * @param domain domain of the socket\r
+ * @param type socket type\r
+ * @param protocol network protocol\r
+ * @return new socket, NULL on error\r
+ */\r
 struct GNUNET_NETWORK_Handle *\r
 GNUNET_NETWORK_socket_socket (int domain, int type, int protocol)\r
 {\r
@@ -276,6 +360,12 @@ GNUNET_NETWORK_socket_socket (int domain, int type, int protocol)
   return ret;\r
 }\r
 \r
+/**\r
+ * Shut down socket operations\r
+ * @param desc socket\r
+ * @param how type of shutdown\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,\r
                                 int how)\r
@@ -288,9 +378,15 @@ GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
     SetErrnoFromWinsockError (WSAGetLastError ());\r
 #endif\r
 \r
-  return ret;\r
+  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;\r
 }\r
 \r
+/**\r
+ * Make a non-inheritable to child processes\r
+ * @param socket\r
+ * @return GNUNET_OK on success, GNUNET_SYSERR otherwise\r
+ * @warning Not implemented on Windows\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_set_inheritable (const struct GNUNET_NETWORK_Handle\r
                                        *desc)\r
@@ -306,6 +402,10 @@ GNUNET_NETWORK_socket_set_inheritable (const struct GNUNET_NETWORK_Handle
 #endif\r
 }\r
 \r
+/**\r
+ * Reset FD set\r
+ * @param fds fd set\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)\r
 {\r
@@ -318,6 +418,11 @@ GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)
 #endif\r
 }\r
 \r
+/**\r
+ * Add a socket to the FD set\r
+ * @param fds fd set\r
+ * @param desc socket to add\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,\r
                           const struct GNUNET_NETWORK_Handle *desc)\r
@@ -328,6 +433,11 @@ GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
     fds->nsds = desc->fd + 1;\r
 }\r
 \r
+/**\r
+ * Check whether a socket is part of the fd set\r
+ * @param fds fd set\r
+ * @param desc socket\r
+ */\r
 int\r
 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,\r
                             const struct GNUNET_NETWORK_Handle *desc)\r
@@ -335,6 +445,11 @@ GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
   return FD_ISSET (desc->fd, &fds->sds);\r
 }\r
 \r
+/**\r
+ * Add one fd set to another\r
+ * @param dst the fd set to add to\r
+ * @param src the fd set to add from\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,\r
                           const struct GNUNET_NETWORK_FDSet *src)\r
@@ -350,6 +465,11 @@ GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
       }\r
 }\r
 \r
+/**\r
+ * Copy one fd set to another\r
+ * @param to destination\r
+ * @param from source\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,\r
                            const struct GNUNET_NETWORK_FDSet *from)\r
@@ -370,6 +490,12 @@ GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
 #endif\r
 }\r
 \r
+/**\r
+ * Copy a native fd set\r
+ * @param to destination\r
+ * @param from native source set\r
+ * @param the biggest socket number in from + 1\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,\r
                                   const fd_set * from, int nfds)\r
@@ -378,6 +504,11 @@ GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
   to->nsds = nfds;\r
 }\r
 \r
+/**\r
+ * Add a file handle to the fd set\r
+ * @param fds fd set\r
+ * @param h the file handle to add\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,\r
                                  const struct GNUNET_DISK_FileHandle *h)\r
@@ -397,6 +528,12 @@ GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
 #endif\r
 }\r
 \r
+/**\r
+ * Check if a file handle is part of an fd set\r
+ * @param fds fd set\r
+ * @param h file handle\r
+ * @return GNUNET_YES if the file handle is part of the set\r
+ */\r
 int\r
 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,\r
                                    const struct GNUNET_DISK_FileHandle *h)\r
@@ -409,6 +546,12 @@ GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
 #endif\r
 }\r
 \r
+/**\r
+ * Checks if two fd sets overlap\r
+ * @param fds1 first fd set\r
+ * @param fds2 second fd set\r
+ * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise\r
+ */\r
 int\r
 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,\r
                               const struct GNUNET_NETWORK_FDSet *fds2)\r
@@ -426,6 +569,10 @@ GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
   return GNUNET_NO;\r
 }\r
 \r
+/**\r
+ * Creates an fd set\r
+ * @return a new fd set\r
+ */\r
 struct GNUNET_NETWORK_FDSet *\r
 GNUNET_NETWORK_fdset_create ()\r
 {\r
@@ -440,6 +587,10 @@ GNUNET_NETWORK_fdset_create ()
   return fds;\r
 }\r
 \r
+/**\r
+ * Releases the associated memory of an fd set\r
+ * @param fds fd set\r
+ */\r
 void\r
 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)\r
 {\r
@@ -449,6 +600,14 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)
   GNUNET_free (fds);\r
 }\r
 \r
+/**\r
+ * Check if sockets meet certain conditions\r
+ * @param rfds set of sockets to be checked for readability\r
+ * @param wfds set of sockets to be checked for writability\r
+ * @param efds set of sockets to be checked for exceptions\r
+ * @param timeout relative value when to return\r
+ * @return number of selected sockets, GNUNET_SYSERR on error\r
+ */\r
 int\r
 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,\r
                               struct GNUNET_NETWORK_FDSet *wfds,\r
@@ -516,23 +675,6 @@ GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
   else\r
     FD_ZERO(&sock_except);\r
 \r
-  /*\r
-  if (rfds)\r
-    FD_COPY (&rfds->sds, &sock_read);\r
-  else\r
-    FD_ZERO(&sock_read);\r
-\r
-  if (wfds)\r
-    FD_COPY (&wfds->sds, &sock_write);\r
-  else\r
-    FD_ZERO(&sock_write);\r
-\r
-  if (efds)\r
-    FD_COPY (&efds->sds, &sock_except);\r
-  else\r
-    FD_ZERO(&sock_except);\r
-*/\r
-\r
   /* multiplex between winsock select() and waiting on the handles */\r
 \r
   FD_ZERO (&aread);\r
index ca084e622d86136f4ae15387212352f6b17f2958..b437351321fdfe2b4fd30723775f29fa0ef99af1 100644 (file)
@@ -324,7 +324,7 @@ process_listen_socket (void *cls,
     {
       /* shutdown was initiated */
       GNUNET_assert (server->listen_socket != NULL);
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (server->listen_socket));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (server->listen_socket));
       server->listen_socket = NULL;
       if (server->do_shutdown)
         destroy_server (server);
@@ -402,20 +402,20 @@ open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                          "setsockopt");
   /* bind the socket */
-  if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) < 0)
+  if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
     {
       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                   _
                   ("`%s' failed for port %d. Is the service already running?\n"),
                   "bind", port);
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
       return NULL;
     }
   if (0 != GNUNET_NETWORK_socket_listen (sock, 5))
     {
       GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (sock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
       return NULL;
     }
 #if DEBUG_SERVER
@@ -468,7 +468,7 @@ GNUNET_SERVER_create (struct GNUNET_SCHEDULER_Handle *sched,
   ret->shutpipe = GNUNET_malloc (sizeof (struct GNUNET_DISK_FileDescriptor *[2]));
   if (NULL == (ret->shutpipe = GNUNET_DISK_pipe (GNUNET_NO)))
     {
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (lsock));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (lsock));
       GNUNET_free (ret->shutpipe);
       GNUNET_free (ret);
       return NULL;
index 1f363788e7919b0e27390745152fcc653370c2f9..efcfa50c98ce186a2755372be702034f5f581581 100644 (file)
@@ -836,7 +836,7 @@ setup_service (struct GNUNET_SERVICE_Context *sctx)
             }
         }
       if (NULL != desc)
-        GNUNET_break (0 == GNUNET_NETWORK_socket_close (desc));
+        GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (desc));
     }
 
 
index dfa6d70b4db0aeab3d553b1473ba1070de9a9ea6..2f82072f9e880fa449afc8d784acfa956870663b 100644 (file)
@@ -66,7 +66,7 @@ open_listen_socket ()
                 "setsockopt");
   GNUNET_assert (GNUNET_NETWORK_socket_bind (desc, 
                                             (const struct sockaddr*) &sa,
-                                            sizeof (sa)) >= 0);
+                                            sizeof (sa)) == GNUNET_OK);
   GNUNET_NETWORK_socket_listen (desc, 5);
   return desc;
 }
index 17ef4d11ae0f3a9a9c6e90fdceac4bf817961d27..b1decebc3731c1685aeb7367dbbe37f989bf35c0 100644 (file)
@@ -65,7 +65,7 @@ open_listen_socket ()
                 "setsockopt");
   GNUNET_assert (GNUNET_NETWORK_socket_bind (desc,
                                             (const struct sockaddr*) &sa,
-                                            sizeof (sa)) >= 0);
+                                            sizeof (sa)) == GNUNET_OK);
   GNUNET_NETWORK_socket_listen (desc, 5);
   return desc;
 }
index aa1340e0230511cda94a63f385b53751f2b3c302..003138530a2a850f67ead6bfd54d8a7849e50e4d 100644 (file)
@@ -66,7 +66,7 @@ open_listen_socket ()
                 "setsockopt");
   GNUNET_assert (GNUNET_NETWORK_socket_bind (desc,
                                             (const struct sockaddr*) &sa,
-                                            sizeof (sa)) >= 0);
+                                            sizeof (sa)) == GNUNET_OK);
   GNUNET_NETWORK_socket_listen (desc, 5);
   return desc;
 }
index 2580ae30a779034dde7fb6e1f9d8859030330574..3a4b69d6776a8248f564a1f25d37f03dcc81adad 100644 (file)
@@ -59,7 +59,7 @@ open_listen_socket ()
                 "setsockopt");
   GNUNET_assert (GNUNET_NETWORK_socket_bind (desc, 
                                             (const struct sockaddr*) &sa, 
-                                            sizeof (sa)) >= 0);
+                                            sizeof (sa)) == GNUNET_OK);
   GNUNET_NETWORK_socket_listen (desc, 5);
   return desc;
 }
index e0cfe28ac2caec4202dab470665b07f791150a0c..e9070a912191d68fa9a86d36efd30f5a8a71340d 100644 (file)
@@ -326,7 +326,7 @@ main (int argc, char *argv[])
     }
   else
     {
-      GNUNET_break (0 == GNUNET_NETWORK_socket_close (s));
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (s));
       ret += check6 ();
       ret += check6d ();        /* with daemonization */
     }