nsapi - Added standardized return types for size and errors

nsapi_error_t         - enum of errors or 0 for NSAPI_ERROR_OK
nsapi_size_t          - unsigned size of data that could be sent
nsapi_size_or_error_t - either a non-negative size or negative error

Author: geky

features/netsocket/CellularInterface.h

@@ -39,8 +39,10 @@ class CellularInterface : public NetworkInterface
      *  @param apn      Optional name of the network to connect to
      *  @param user     Optional username for the APN
      *  @param pass     Optional password fot the APN
+     *  @return         0 on success, negative error code on failure
      */
-    virtual int set_credentials(const char *apn, const char *user = 0, const char *pass = 0) = 0;
+    virtual nsapi_error_t set_credentials(const char *apn,
+            const char *username = 0, const char *password = 0) = 0;
 
     /** Start the interface
      *
@@ -49,21 +51,22 @@ class CellularInterface : public NetworkInterface
      *  @param password Optional password for your APN 
      *  @return         0 on success, negative error code on failure
      */
-    virtual int connect(const char *apn, const char *username = 0, const char *password = 0) = 0;
+    virtual nsapi_error_t connect(const char *apn,
+            const char *username = 0, const char *password = 0) = 0;
 
     /** Start the interface
      *
      *  Attempts to connect to a cellular network based on supplied credentials
      *
      *  @return         0 on success, negative error code on failure
      */
-    virtual int connect() = 0;
+    virtual nsapi_error_t connect() = 0;
 
     /** Stop the interface
      *
      *  @return         0 on success, negative error code on failure
      */
-    virtual int disconnect() = 0;
+    virtual nsapi_error_t disconnect() = 0;
 };
 
 

features/netsocket/NetworkInterface.cpp

@@ -40,27 +40,27 @@ const char *NetworkInterface::get_gateway()
     return 0;
 }
 
-int NetworkInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)
+nsapi_error_t NetworkInterface::set_network(const char *ip_address, const char *netmask, const char *gateway)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
 
-int NetworkInterface::set_dhcp(bool dhcp)
+nsapi_error_t NetworkInterface::set_dhcp(bool dhcp)
 {
     if (!dhcp) {
         return NSAPI_ERROR_UNSUPPORTED;
     } else {
-        return 0;
+        return NSAPI_ERROR_OK;
     }
 }
 
 // DNS operations go through the underlying stack by default
-int NetworkInterface::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
+nsapi_error_t NetworkInterface::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
 {
     return get_stack()->gethostbyname(name, address, version);
 }
 
-int NetworkInterface::add_dns_server(const SocketAddress &address)
+nsapi_error_t NetworkInterface::add_dns_server(const SocketAddress &address)
 {
     return get_stack()->add_dns_server(address);
 }

features/netsocket/NetworkInterface.h

@@ -78,7 +78,8 @@ class NetworkInterface {
      *  @param gateway  Null-terminated representation of the local gateway
      *  @return         0 on success, negative error code on failure
      */
-    virtual int set_network(const char *ip_address, const char *netmask, const char *gateway);
+    virtual nsapi_error_t set_network(
+            const char *ip_address, const char *netmask, const char *gateway);
 
     /** Enable or disable DHCP on the network
      *
@@ -89,19 +90,19 @@ class NetworkInterface {
      *  @param dhcp     True to enable DHCP
      *  @return         0 on success, negative error code on failure
      */
-    virtual int set_dhcp(bool dhcp);
+    virtual nsapi_error_t set_dhcp(bool dhcp);
 
     /** Start the interface
      *
      *  @return     0 on success, negative error code on failure
      */
-    virtual int connect() = 0;
+    virtual nsapi_error_t connect() = 0;
 
     /** Stop the interface
      *
      *  @return     0 on success, negative error code on failure
      */
-    virtual int disconnect() = 0;
+    virtual nsapi_error_t disconnect() = 0;
 
     /** Translates a hostname to an IP address with specific version
      *
@@ -117,14 +118,15 @@ class NetworkInterface {
      *                  version is chosen by the stack (defaults to NSAPI_UNSPEC)
      *  @return         0 on success, negative error code on failure
      */
-    virtual int gethostbyname(const char *host, SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC);
+    virtual nsapi_error_t gethostbyname(const char *host,
+            SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC);
 
     /** Add a domain name server to list of servers to query
      *
      *  @param addr     Destination for the host address
      *  @return         0 on success, negative error code on failure
      */
-    virtual int add_dns_server(const SocketAddress &address);
+    virtual nsapi_error_t add_dns_server(const SocketAddress &address);
 
 protected:
     friend class Socket;

features/netsocket/NetworkStack.cpp

@@ -22,15 +22,15 @@
 
 
 // Default NetworkStack operations
-int NetworkStack::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
+nsapi_error_t NetworkStack::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
 {
     // check for simple ip addresses
     if (address->set_ip_address(name)) {
         if (address->get_ip_version() != version) {
             return NSAPI_ERROR_DNS_FAILURE;
         }
 
-        return 0;
+        return NSAPI_ERROR_OK;
     }
 
     // if the version is unspecified, try to guess the version from the
@@ -45,27 +45,27 @@ int NetworkStack::gethostbyname(const char *name, SocketAddress *address, nsapi_
     return nsapi_dns_query(this, name, address, version);
 }
 
-int NetworkStack::add_dns_server(const SocketAddress &address)
+nsapi_error_t NetworkStack::add_dns_server(const SocketAddress &address)
 {
     return nsapi_dns_add_server(address);
 }
 
-int NetworkStack::setstackopt(int level, int optname, const void *optval, unsigned optlen)
+nsapi_error_t NetworkStack::setstackopt(int level, int optname, const void *optval, unsigned optlen)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
 
-int NetworkStack::getstackopt(int level, int optname, void *optval, unsigned *optlen)
+nsapi_error_t NetworkStack::getstackopt(int level, int optname, void *optval, unsigned *optlen)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
 
-int NetworkStack::setsockopt(void *handle, int level, int optname, const void *optval, unsigned optlen)
+nsapi_error_t NetworkStack::setsockopt(void *handle, int level, int optname, const void *optval, unsigned optlen)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
 
-int NetworkStack::getsockopt(void *handle, int level, int optname, void *optval, unsigned *optlen)
+nsapi_error_t NetworkStack::getsockopt(void *handle, int level, int optname, void *optval, unsigned *optlen)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
@@ -99,19 +99,19 @@ class NetworkStackWrapper : public NetworkStack
         return address->get_ip_address();
     }
 
-    virtual int gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
+    virtual nsapi_error_t gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
     {
         if (!_stack_api()->gethostbyname) {
             return NetworkStack::gethostbyname(name, address, version);
         }
 
         nsapi_addr_t addr = {NSAPI_UNSPEC, 0};
-        int err = _stack_api()->gethostbyname(_stack(), name, &addr, version);
+        nsapi_error_t err = _stack_api()->gethostbyname(_stack(), name, &addr, version);
         address->set_addr(addr);
         return err;
     }
 
-    virtual int add_dns_server(const SocketAddress &address)
+    virtual nsapi_error_t add_dns_server(const SocketAddress &address)
     {
         if (!_stack_api()->add_dns_server) {
             return NetworkStack::add_dns_server(address);
@@ -120,7 +120,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->add_dns_server(_stack(), address.get_addr());
     }
 
-    virtual int setstackopt(int level, int optname, const void *optval, unsigned optlen)
+    virtual nsapi_error_t setstackopt(int level, int optname, const void *optval, unsigned optlen)
     {
         if (!_stack_api()->setstackopt) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -129,7 +129,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->setstackopt(_stack(), level, optname, optval, optlen);
     }
 
-    virtual int getstackopt(int level, int optname, void *optval, unsigned *optlen)
+    virtual nsapi_error_t getstackopt(int level, int optname, void *optval, unsigned *optlen)
     {
         if (!_stack_api()->getstackopt) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -139,7 +139,7 @@ class NetworkStackWrapper : public NetworkStack
     }
 
 protected:
-    virtual int socket_open(nsapi_socket_t *socket, nsapi_protocol_t proto)
+    virtual nsapi_error_t socket_open(nsapi_socket_t *socket, nsapi_protocol_t proto)
     {
         if (!_stack_api()->socket_open) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -148,7 +148,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_open(_stack(), socket, proto);
     }
 
-    virtual int socket_close(nsapi_socket_t socket)
+    virtual nsapi_error_t socket_close(nsapi_socket_t socket)
     {
         if (!_stack_api()->socket_close) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -157,7 +157,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_close(_stack(), socket);
     }
 
-    virtual int socket_bind(nsapi_socket_t socket, const SocketAddress &address)
+    virtual nsapi_error_t socket_bind(nsapi_socket_t socket, const SocketAddress &address)
     {
         if (!_stack_api()->socket_bind) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -166,7 +166,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_bind(_stack(), socket, address.get_addr(), address.get_port());
     }
 
-    virtual int socket_listen(nsapi_socket_t socket, int backlog)
+    virtual nsapi_error_t socket_listen(nsapi_socket_t socket, int backlog)
     {
         if (!_stack_api()->socket_listen) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -175,7 +175,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_listen(_stack(), socket, backlog);
     }
 
-    virtual int socket_connect(nsapi_socket_t socket, const SocketAddress &address)
+    virtual nsapi_error_t socket_connect(nsapi_socket_t socket, const SocketAddress &address)
     {
         if (!_stack_api()->socket_connect) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -184,7 +184,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_connect(_stack(), socket, address.get_addr(), address.get_port());
     }
 
-    virtual int socket_accept(nsapi_socket_t server, nsapi_socket_t *socket, SocketAddress *address)
+    virtual nsapi_error_t socket_accept(nsapi_socket_t server, nsapi_socket_t *socket, SocketAddress *address)
     {
         if (!_stack_api()->socket_accept) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -193,7 +193,7 @@ class NetworkStackWrapper : public NetworkStack
         nsapi_addr_t addr = {NSAPI_IPv4, 0};
         uint16_t port = 0;
 
-        int err = _stack_api()->socket_accept(_stack(), server, socket, &addr, &port);
+        nsapi_error_t err = _stack_api()->socket_accept(_stack(), server, socket, &addr, &port);
 
         if (address) {
             address->set_addr(addr);
@@ -203,7 +203,7 @@ class NetworkStackWrapper : public NetworkStack
         return err;
     }
 
-    virtual int socket_send(nsapi_socket_t socket, const void *data, unsigned size)
+    virtual nsapi_size_or_error_t socket_send(nsapi_socket_t socket, const void *data, nsapi_size_t size)
     {
         if (!_stack_api()->socket_send) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -212,7 +212,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_send(_stack(), socket, data, size);
     }
 
-    virtual int socket_recv(nsapi_socket_t socket, void *data, unsigned size)
+    virtual nsapi_size_or_error_t socket_recv(nsapi_socket_t socket, void *data, nsapi_size_t size)
     {
         if (!_stack_api()->socket_recv) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -221,7 +221,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_recv(_stack(), socket, data, size);
     }
 
-    virtual int socket_sendto(nsapi_socket_t socket, const SocketAddress &address, const void *data, unsigned size)
+    virtual nsapi_size_or_error_t socket_sendto(nsapi_socket_t socket, const SocketAddress &address, const void *data, nsapi_size_t size)
     {
         if (!_stack_api()->socket_sendto) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -230,7 +230,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_sendto(_stack(), socket, address.get_addr(), address.get_port(), data, size);
     }
 
-    virtual int socket_recvfrom(nsapi_socket_t socket, SocketAddress *address, void *data, unsigned size)
+    virtual nsapi_size_or_error_t socket_recvfrom(nsapi_socket_t socket, SocketAddress *address, void *data, nsapi_size_t size)
     {
         if (!_stack_api()->socket_recvfrom) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -239,7 +239,7 @@ class NetworkStackWrapper : public NetworkStack
         nsapi_addr_t addr = {NSAPI_IPv4, 0};
         uint16_t port = 0;
 
-        int err = _stack_api()->socket_recvfrom(_stack(), socket, &addr, &port, data, size);
+        nsapi_size_or_error_t err = _stack_api()->socket_recvfrom(_stack(), socket, &addr, &port, data, size);
 
         if (address) {
             address->set_addr(addr);
@@ -258,7 +258,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->socket_attach(_stack(), socket, callback, data);
     }
 
-    virtual int setsockopt(nsapi_socket_t socket, int level, int optname, const void *optval, unsigned optlen)
+    virtual nsapi_error_t setsockopt(nsapi_socket_t socket, int level, int optname, const void *optval, unsigned optlen)
     {
         if (!_stack_api()->setsockopt) {
             return NSAPI_ERROR_UNSUPPORTED;
@@ -267,7 +267,7 @@ class NetworkStackWrapper : public NetworkStack
         return _stack_api()->setsockopt(_stack(), socket, level, optname, optval, optlen);
     }
 
-    virtual int getsockopt(nsapi_socket_t socket, int level, int optname, void *optval, unsigned *optlen)
+    virtual nsapi_error_t getsockopt(nsapi_socket_t socket, int level, int optname, void *optval, unsigned *optlen)
     {
         if (!_stack_api()->getsockopt) {
             return NSAPI_ERROR_UNSUPPORTED;