Added better support for NetworkInterface/NetworkStack

Mostly reduced code duplication for NetworkInterface/NetworkStack
arguments.

Moved to templated Socket constructors/open member functions. This
allows multiple inheritance to be used for classes that provide
both a NetworkInterface and NetworkStack, such as the esp8266.

Author: geky

Socket.cpp

@@ -17,35 +17,34 @@
 #include "Socket.h"
 
 Socket::Socket()
-    : _iface(0)
+    : _stack(0)
     , _socket(0)
     , _timeout(osWaitForever)
 {
 }
 
-int Socket::open(NetworkStack *iface, nsapi_protocol_t proto)
+int Socket::open(NetworkStack *stack, nsapi_protocol_t proto)
 {
     _lock.lock();
 
-    if (_iface != NULL) {
+    if (_stack != NULL || stack == NULL) {
         _lock.unlock();
         return NSAPI_ERROR_PARAMETER;
     }
-    _iface = iface;
+    _stack = stack;
 
-    void *socket;
-    int err = _iface->socket_open(&socket, proto);
+    nsapi_socket_t socket;
+    int err = _stack->socket_open(&socket, proto);
     if (err) {
         _lock.unlock();
         return err;
     }
 
     _socket = socket;
     _event.attach(this, &Socket::event);
-    _iface->socket_attach(_socket, Callback<void()>::thunk, &_event);
+    _stack->socket_attach(_socket, Callback<void()>::thunk, &_event);
 
     _lock.unlock();
-
     return 0;
 }
 
@@ -55,11 +54,10 @@ int Socket::close()
 
     int ret = 0;
     if (_socket) {
-        _iface->socket_attach(_socket, 0, 0);
-
-        void * socket = _socket;
+        _stack->socket_attach(_socket, 0, 0);
+        nsapi_socket_t socket = _socket;
         _socket = 0;
-        ret = _iface->socket_close(socket);
+        ret = _stack->socket_close(socket);
     }
 
     // Wakeup anything in a blocking operation
@@ -87,10 +85,12 @@ int Socket::bind(const char *address, uint16_t port)
 int Socket::bind(const SocketAddress &address)
 {
     _lock.lock();
+    int ret;
 
-    int ret = NSAPI_ERROR_NO_SOCKET;
-    if (_socket) {
-        ret = _iface->socket_bind(_socket, address);
+    if (!_socket) {
+        ret = NSAPI_ERROR_NO_SOCKET;
+    } else {
+        ret = _stack->socket_bind(_socket, address);
     }
 
     _lock.unlock();
@@ -119,10 +119,12 @@ void Socket::set_timeout(int timeout)
 int Socket::setsockopt(int level, int optname, const void *optval, unsigned optlen)
 {
     _lock.lock();
+    int ret;
 
-    int ret = NSAPI_ERROR_NO_SOCKET;
-    if (_socket) {
-        ret = _iface->setsockopt(_socket, level, optname, optval, optlen);
+    if (!_socket) {
+        ret = NSAPI_ERROR_NO_SOCKET;
+    } else {
+        ret = _stack->setsockopt(_socket, level, optname, optval, optlen);
     }
 
     _lock.unlock();
@@ -132,10 +134,12 @@ int Socket::setsockopt(int level, int optname, const void *optval, unsigned optl
 int Socket::getsockopt(int level, int optname, void *optval, unsigned *optlen)
 {
     _lock.lock();
+    int ret;
 
-    int ret = NSAPI_ERROR_NO_SOCKET;
-    if (_socket) {
-        ret = _iface->getsockopt(_socket, level, optname, optval, optlen);
+    if (!_socket) {
+        ret = NSAPI_ERROR_NO_SOCKET;
+    } else {
+        ret = _stack->getsockopt(_socket, level, optname, optval, optlen);
     }
 
     _lock.unlock();

Socket.h

@@ -39,13 +39,19 @@ class Socket {
 
     /** Opens a socket
      *
-     *  Creates a network socket on the specified network stack.
-     *  Not needed if stack is passed to the socket's constructor.
+     *  Creates a network socket on the network stack of the given
+     *  network interface. Not needed if stack is passed to the
+     *  socket's constructor.
      *
-     *  @param iface    Network stack as target for socket
+     *  @param stack    Network stack as target for socket
      *  @return         0 on success, negative error code on failure
      */
-    virtual int open(NetworkStack *iface) = 0;
+    virtual int open(NetworkStack *stack) = 0;
+
+    template <typename IF>
+    int open(IF *iface) {
+        return open(iface->get_stack());
+    }
 
     /** Close the socket
      *
@@ -174,10 +180,10 @@ class Socket {
 
 protected:
     Socket();
-    int open(NetworkStack *iface, nsapi_protocol_t proto);
+    int open(NetworkStack *stack, nsapi_protocol_t proto);
     virtual void event() = 0;
 
-    NetworkStack *_iface;
+    NetworkStack *_stack;
     nsapi_socket_t _socket;
     uint32_t _timeout;
     mbed::Callback<void()> _event;

SocketAddress.cpp

@@ -148,11 +148,6 @@ SocketAddress::SocketAddress(NetworkStack *iface, const char *host, uint16_t por
     _SocketAddress(iface, host, port);
 }
 
-SocketAddress::SocketAddress(NetworkInterface *iface, const char *host, uint16_t port)
-{
-    _SocketAddress(iface->get_stack(), host, port);
-}
-
 SocketAddress::SocketAddress(nsapi_addr_t addr, uint16_t port)
 {
     _ip_address[0] = '\0';

SocketAddress.h

@@ -31,19 +31,6 @@ class NetworkInterface;
  */
 class SocketAddress {
 public:
-    /** Create a SocketAddress from a hostname and port
-     *
-     *  The hostname may be either a domain name or an IP address. If the
-     *  hostname is an IP address, no network transactions will be performed.
-     *
-     *  On failure, the IP address and port will be set to zero
-     *  
-     *  @param iface    Network stack to use for DNS resolution
-     *  @param host     Hostname to resolve
-     *  @param port     Optional 16-bit port
-     */
-    SocketAddress(NetworkStack *iface, const char *host, uint16_t port = 0);
-
     /** Create a SocketAddress from a hostname and port
      *
      *  The hostname may be either a domain name or an IP address. If the
@@ -55,7 +42,13 @@ class SocketAddress {
      *  @param host     Hostname to resolve
      *  @param port     Optional 16-bit port
      */
-    SocketAddress(NetworkInterface *iface, const char *host, uint16_t port = 0);
+    SocketAddress(NetworkStack *iface, const char *host, uint16_t port = 0);
+
+    template <typename IF>
+    SocketAddress(IF *iface, const char *host, uint16_t port = 0)
+    {
+        _SocketAddress(iface->get_stack(), host, port);
+    }
 
     /** Create a SocketAddress from a raw IP address and port
      *

TCPServer.cpp

@@ -22,40 +22,31 @@ TCPServer::TCPServer()
 {
 }
 
-TCPServer::TCPServer(NetworkStack *iface)
+TCPServer::TCPServer(NetworkStack *stack)
     : _pending(0), _accept_sem(0)
 {
-    open(iface);
-}
-
-TCPServer::TCPServer(NetworkInterface *iface)
-    : _pending(0), _accept_sem(0)
-{
-    open(iface->get_stack());
+    open(stack);
 }
 
 TCPServer::~TCPServer()
 {
     close();
 }
 
-int TCPServer::open(NetworkStack *iface)
+int TCPServer::open(NetworkStack *stack)
 {
-    return Socket::open(iface, NSAPI_TCP);
-}
-
-int TCPServer::open(NetworkInterface *iface)
-{
-    return TCPServer::open(iface->get_stack());
+    return Socket::open(stack, NSAPI_TCP);
 }
 
 int TCPServer::listen(int backlog)
 {
     _lock.lock();
+    int ret;
 
-    int ret = NSAPI_ERROR_NO_SOCKET;
-    if (_socket) {
-        ret = _iface->socket_listen(_socket, backlog);
+    if (!_socket) {
+        ret = NSAPI_ERROR_NO_SOCKET;
+    } else {
+        ret = _stack->socket_listen(_socket, backlog);
     }
 
     _lock.unlock();
@@ -65,28 +56,29 @@ int TCPServer::listen(int backlog)
 int TCPServer::accept(TCPSocket *connection)
 {
     _lock.lock();
+    int ret;
 
-    int ret = NSAPI_ERROR_NO_SOCKET;
     while (true) {
         if (!_socket) {
             ret = NSAPI_ERROR_NO_SOCKET;
             break;
-        }
+        } 
 
         _pending = 0;
         void *socket;
-        ret = _iface->socket_accept(&socket, _socket);
+        ret = _stack->socket_accept(&socket, _socket);
+
         if (0 == ret) {
             connection->_lock.lock();
 
             if (connection->_socket) {
                 connection->close();
             }
 
-            connection->_iface = _iface;
+            connection->_stack = _stack;
             connection->_socket = socket;
             connection->_event = Callback<void()>(connection, &TCPSocket::event);
-            _iface->socket_attach(socket, &Callback<void()>::thunk, &connection->_event);
+            _stack->socket_attach(socket, &Callback<void()>::thunk, &connection->_event);
 
             connection->_lock.unlock();
             break;

TCPServer.h

@@ -34,49 +34,43 @@ class TCPServer : public Socket {
      */
     TCPServer();
 
-    /** Destroy a socket
-     *
-     *  Closes socket if the socket is still open
-     */
-    virtual ~TCPServer();
-
-    /** Create a socket on a network stack
-     *
-     *  Creates and opens a socket on the specified network stack.
-     *
-     *  @param iface    Network stack as target for socket
-     */
-    TCPServer(NetworkStack *iface);
-
     /** Create a socket on a network interface
      *
      *  Creates and opens a socket on the network stack of the given
      *  network interface.
      *
-     *  @param iface    Network interface as target for socket
+     *  @param stack    Network stack as target for socket
      */
-    TCPServer(NetworkInterface *iface);
+    TCPServer(NetworkStack *stack);
 
-    /** Opens a socket
-     *
-     *  Creates a network socket on the specified network stack.
-     *  Not needed if stack is passed to the socket's constructor.
+    template <typename IF>
+    TCPServer(IF *iface)
+        : _pending(0), _accept_sem(0)
+    {
+        open(iface->get_stack());
+    }
+
+    /** Destroy a socket
      *
-     *  @param iface    Network stack as target for socket
-     *  @return         0 on success, negative error code on failure
+     *  Closes socket if the socket is still open
      */
-    virtual int open(NetworkStack *iface);
-    
+    virtual ~TCPServer();
+
     /** Opens a socket
      *
      *  Creates a network socket on the network stack of the given
      *  network interface. Not needed if stack is passed to the
      *  socket's constructor.
      *
-     *  @param iface    Network interface as target for socket
+     *  @param stack    Network stack as target for socket
      *  @return         0 on success, negative error code on failure
      */
-    virtual int open(NetworkInterface *iface);
+    virtual int open(NetworkStack *stack);
+
+    template <typename IF>
+    int open(IF *iface) {
+        return open(iface->get_stack());
+    }
 
     /** Listen for connections on a TCP socket
      *
@@ -105,6 +99,7 @@ class TCPServer : public Socket {
     int accept(TCPSocket *connection);
 protected:
     virtual void event();
+
     volatile unsigned _pending;
     rtos::Semaphore _accept_sem;
 };