Diff: Socket.h

Revision:

4:bbe51641f405

Parent:

3:dea0cdb42241

Child:

5:b66a6984ed2d

--- a/Socket.h	Tue Apr 05 06:56:22 2016 -0500
+++ b/Socket.h	Tue Apr 05 09:07:28 2016 -0500
@@ -18,25 +18,21 @@
 #ifndef SOCKET_H
 #define SOCKET_H
 
-/** Maximum storage needed for IP addresses
- */
-#define NS_API_SIZE 40
-
 /**
  *  @enum ns_error_t
  *  @brief enum of standardized error codes
  */
 enum ns_error_t {
-    NS_ERROR_WOULD_BLOCK   = -3001,     /*!< no data is not available but call is non-blocking */
-    NS_ERROR_UNSUPPORTED   = -3002,     /*!< unsupported configuration */
-    NS_ERROR_NO_CONNECTION = -3003,     /*!< not connected to a network */
-    NS_ERROR_NO_SOCKET     = -3004,     /*!< socket not available for use */
-    NS_ERROR_NO_ADDRESS    = -3005,     /*!< IP address is not known */
-    NS_ERROR_NO_MEMORY     = -3006,     /*!< memory resource not available */
-    NS_ERROR_DNS_FAILURE   = -3007,     /*!< DNS failed to complete successfully */
-    NS_ERROR_DHCP_FAILURE  = -3008,     /*!< DHCP failed to complete successfully */
-    NS_ERROR_AUTH_FAILURE  = -3009,     /*!< connection to access point faield */
-    NS_ERROR_DEVICE_ERROR  = -3010,     /*!< failure interfacing with the network procesor */
+    NSAPI_ERROR_WOULD_BLOCK   = -3001,     /*!< no data is not available but call is non-blocking */
+    NSAPI_ERROR_UNSUPPORTED   = -3002,     /*!< unsupported configuration */
+    NSAPI_ERROR_NO_CONNECTION = -3003,     /*!< not connected to a network */
+    NSAPI_ERROR_NO_SOCKET     = -3004,     /*!< socket not available for use */
+    NSAPI_ERROR_NO_ADDRESS    = -3005,     /*!< IP address is not known */
+    NSAPI_ERROR_NO_MEMORY     = -3006,     /*!< memory resource not available */
+    NSAPI_ERROR_DNS_FAILURE   = -3007,     /*!< DNS failed to complete successfully */
+    NSAPI_ERROR_DHCP_FAILURE  = -3008,     /*!< DHCP failed to complete successfully */
+    NSAPI_ERROR_AUTH_FAILURE  = -3009,     /*!< connection to access point faield */
+    NSAPI_ERROR_DEVICE_ERROR  = -3010,     /*!< failure interfacing with the network procesor */
 };
 
 /**
@@ -67,18 +63,18 @@
     void set_timeout(unsigned int timeout);
 
     /** Set socket options
-    \param optname   option ID
-    \param optval    option value
-    \param optlen    length of the option value
-    \return 0 on success, negative on failure
+    \param optname  Option ID
+    \param optval   Option value
+    \param optlen   Length of the option value
+    \return         0 on success, negative on failure
     */
     int set_option(int optname, const void *optval, unsigned int optlen);
     
     /** Get socket options
-    \param optname   option ID
-    \param optval    buffer pointer where to write the option value
-    \param socklen_t length of the option value
-    \return 0 on success, negative on failure
+    \param optname  Option ID
+    \param optval   Buffer pointer where to write the option value
+    \param optlen   Length of the option value
+    \return         0 on success, negative on failure
     */
     int get_option(int optname, void *optval, unsigned int *optlen);