Merge pull request #88 from geky/nsapi-changes

Update Network Socket API

Author: sg-

net/ESP8266Interface/ESP8266Interface.cpp

@@ -84,7 +84,7 @@ struct esp8266_socket {
     bool connected;
 };
 
-void *ESP8266Interface::socket_create(nsapi_protocol_t proto)
+int ESP8266Interface::socket_open(void **handle, nsapi_protocol_t proto)
 {
     // Look for an unused socket
     int id = -1;
@@ -98,38 +98,37 @@ void *ESP8266Interface::socket_create(nsapi_protocol_t proto)
     }
 
     if (id == -1) {
-        return 0;
+        return NSAPI_ERROR_NO_SOCKET;
     }
 
     struct esp8266_socket *socket = new struct esp8266_socket;
     if (!socket) {
-        return 0;
+        return NSAPI_ERROR_NO_SOCKET;
     }
 
     socket->id = id;
     socket->proto = proto;
     socket->connected = false;
-    return socket;
+    *handle = socket;
+    return 0;
 }
 
-void ESP8266Interface::socket_destroy(void *handle)
+int ESP8266Interface::socket_close(void *handle)
 {
     struct esp8266_socket *socket = (struct esp8266_socket *)handle;
+    int err = 0;
+    _esp.setTimeout(ESP8266_MISC_TIMEOUT);
+ 
+    if (!_esp.close(socket->id)) {
+        err = NSAPI_ERROR_DEVICE_ERROR;
+    }
+
     _ids[socket->id] = false;
     delete socket;
+    return err;
 }
 
-int ESP8266Interface::socket_set_option(void *handle, int optname, const void *optval, unsigned optlen)
-{
-    return NSAPI_ERROR_UNSUPPORTED;
-}
-
-int ESP8266Interface::socket_get_option(void *handle, int optname, void *optval, unsigned *optlen)
-{
-    return NSAPI_ERROR_UNSUPPORTED;
-}
-
-int ESP8266Interface::socket_bind(void *handle, int port)
+int ESP8266Interface::socket_bind(void *handle, const SocketAddress &address)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
@@ -153,12 +152,7 @@ int ESP8266Interface::socket_connect(void *handle, const SocketAddress &addr)
     return 0;
 }
 
-bool ESP8266Interface::socket_is_connected(void *handle)
-{
-    return true;
-}
-
-int ESP8266Interface::socket_accept(void *handle, void **connection)
+int ESP8266Interface::socket_accept(void **handle, void *server)
 {
     return NSAPI_ERROR_UNSUPPORTED;
 }
@@ -207,26 +201,6 @@ int ESP8266Interface::socket_recvfrom(void *handle, SocketAddress *addr, void *d
     return socket_recv(socket, data, size);
 }
 
-int ESP8266Interface::socket_close(void *handle, bool shutdown)
-{
-    struct esp8266_socket *socket = (struct esp8266_socket *)handle;
-    _esp.setTimeout(ESP8266_MISC_TIMEOUT);
- 
-    if (!_esp.close(socket->id)) {
-        return NSAPI_ERROR_DEVICE_ERROR;
-    }
- 
-    return 0;
-}
-
-void ESP8266Interface::socket_attach_accept(void *handle, void (*callback)(void *), void *id)
-{
-}
-
-void ESP8266Interface::socket_attach_send(void *handle, void (*callback)(void *), void *id)
-{
-}
-
-void ESP8266Interface::socket_attach_recv(void *handle, void (*callback)(void *), void *id)
+void ESP8266Interface::socket_attach(void *handle, void (*callback)(void *), void *data)
 {
 }

net/ESP8266Interface/ESP8266Interface.h

@@ -23,189 +23,150 @@
 #define ESP8266_SOCKET_COUNT 5
 
 /** ESP8266Interface class
- *  Implementation of the NetworkInterface for the ESP8266
+ *  Implementation of the NetworkStack for the ESP8266
  */
-class ESP8266Interface : public WiFiInterface
+class ESP8266Interface : public NetworkStack, public WiFiInterface
 {
 public:
     /** ESP8266Interface lifetime
-    /param tx       TX pin
-    /param rx       RX pin
-    /param debug    Enable debugging
-    */
+     * @param tx        TX pin
+     * @param rx        RX pin
+     * @param debug     Enable debugging
+     */
     ESP8266Interface(PinName tx, PinName rx, bool debug = false);
 
     /** Start the interface
-    /param ssid     Name of the network to connect to
-    /param pass     Security passphrase to connect to the network
-    /param security Type of encryption for connection
-    /return         0 on success, negative on failure
-    */
+     *
+     *  Attempts to connect to a WiFi network. If passphrase is invalid,
+     *  NSAPI_ERROR_AUTH_ERROR is returned.
+     *
+     *  @param ssid      Name of the network to connect to
+     *  @param pass      Security passphrase to connect to the network
+     *  @param security  Type of encryption for connection
+     *  @return          0 on success, negative error code on failure
+     */
     virtual int connect(
         const char *ssid,
         const char *pass,
         nsapi_security_t security = NSAPI_SECURITY_NONE);
 
     /** Stop the interface
-     *  @return     0 on success, negative on failure
+     *  @return             0 on success, negative on failure
      */
     virtual int disconnect();
 
     /** Get the internally stored IP address
-    /return     IP address of the interface or null if not yet connected
-    */
+     *  @return             IP address of the interface or null if not yet connected
+     */
     virtual const char *get_ip_address();
 
     /** Get the internally stored MAC address
-    /return     MAC address of the interface
-    */
+     *  @return             MAC address of the interface
+     */
     virtual const char *get_mac_address();
 
 protected:
-    /** Create a socket
-    /param proto    The type of socket to open, TCP or UDP
-    /return         The alocated socket or null on failure
-    */
-    virtual void *socket_create(nsapi_protocol_t proto);
-
-    /** Destroy a socket
-    /param socket   Previously allocated socket
-    */
-    virtual void socket_destroy(void *handle);
-
-    /** Set socket options
-    \param handle   Socket handle
-    \param optname  Option ID
-    \param optval   Option value
-    \param optlen   Length of the option value
-    \return         0 on success, negative on failure
-    */    
-    virtual int socket_set_option(void *handle, int optname, const void *optval, unsigned int optlen);
-
-    /** Get socket options
-    \param handle   Socket handle
-    \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
-    */
-    virtual int socket_get_option(void *handle, int optname, void *optval, unsigned int *optlen);
+    /** Open a socket
+     *  @param handle       Handle in which to store new socket
+     *  @param proto        Type of socket to open, NSAPI_TCP or NSAPI_UDP
+     *  @return             0 on success, negative on failure
+     */
+    virtual int socket_open(void **handle, nsapi_protocol_t proto);
+
+    /** Close the socket
+     *  @param handle       Socket handle
+     *  @return             0 on success, negative on failure
+     *  @note On failure, any memory associated with the socket must still 
+     *        be cleaned up
+     */
+    virtual int socket_close(void *handle);
 
     /** Bind a server socket to a specific port
-    \param handle   Socket handle
-    \param port     The port to listen for incoming connections on
-    \return         0 on success, negative on failure.
-    */
-    virtual int socket_bind(void *handle, int port);
+     *  @param handle       Socket handle
+     *  @param address      Local address to listen for incoming connections on 
+     *  @return             0 on success, negative on failure.
+     */
+    virtual int socket_bind(void *handle, const SocketAddress &address);
 
     /** Start listening for incoming connections
-    \param handle   Socket handle
-    \param backlog  Number of pending connections that can be queued up at any
-                    one time [Default: 1]
-    \return         0 on success, negative on failure
-    */
+     *  @param handle       Socket handle
+     *  @param backlog      Number of pending connections that can be queued up at any
+     *                      one time [Default: 1]
+     *  @return             0 on success, negative on failure
+     */
     virtual int socket_listen(void *handle, int backlog);
 
     /** Connects this TCP socket to the server
-    \param handle   Socket handle
-    \param address  SocketAddress to connect to
-    \return         0 on success, negative on failure
-    */
+     *  @param handle       Socket handle
+     *  @param address      SocketAddress to connect to
+     *  @return             0 on success, negative on failure
+     */
     virtual int socket_connect(void *handle, const SocketAddress &address);
-    
-    /** Check if the socket is connected
-    \param handle   Socket handle
-    \return         true if connected, false otherwise
-    */
-    virtual bool socket_is_connected(void *handle);
 
     /** Accept a new connection.
-    \param handle   Socket handle
-    \param socket   A TCPSocket instance that will handle the incoming connection.
-    \return         0 on success, negative on failure.
-    \note This call is not-blocking, if this call would block, must
-          immediately return NSAPI_ERROR_WOULD_WAIT
-    */
-    virtual int socket_accept(void *handle, void **connection);
+     *  @param handle       Handle in which to store new socket
+     *  @param server       Socket handle to server to accept from
+     *  @return             0 on success, negative on failure
+     *  @note This call is not-blocking, if this call would block, must
+     *        immediately return NSAPI_ERROR_WOULD_WAIT
+     */
+    virtual int socket_accept(void **handle, void *server);
 
     /** Send data to the remote host
-    \param handle   Socket handle
-    \param data     The buffer to send to the host
-    \param size     The length of the buffer to send
-    \return         Number of written bytes on success, negative on failure
-    \note This call is not-blocking, if this call would block, must
-          immediately return NSAPI_ERROR_WOULD_WAIT
-    */
+     *  @param handle       Socket handle
+     *  @param data         The buffer to send to the host
+     *  @param size         The length of the buffer to send
+     *  @return             Number of written bytes on success, negative on failure
+     *  @note This call is not-blocking, if this call would block, must
+     *        immediately return NSAPI_ERROR_WOULD_WAIT
+     */
     virtual int socket_send(void *handle, const void *data, unsigned size);
 
     /** Receive data from the remote host
-    \param handle   Socket handle
-    \param data     The buffer in which to store the data received from the host
-    \param size     The maximum length of the buffer
-    \return         Number of received bytes on success, negative on failure
-    \note This call is not-blocking, if this call would block, must
-          immediately return NSAPI_ERROR_WOULD_WAIT
-    */
+     *  @param handle       Socket handle
+     *  @param data         The buffer in which to store the data received from the host
+     *  @param size         The maximum length of the buffer
+     *  @return             Number of received bytes on success, negative on failure
+     *  @note This call is not-blocking, if this call would block, must
+     *        immediately return NSAPI_ERROR_WOULD_WAIT
+     */
     virtual int socket_recv(void *handle, void *data, unsigned size);
 
     /** Send a packet to a remote endpoint
-    \param handle   Socket handle
-    \param address  The remote SocketAddress
-    \param data     The packet to be sent
-    \param size     The length of the packet to be sent
-    \return the number of written bytes on success, negative on failure
-    \note This call is not-blocking, if this call would block, must
-          immediately return NSAPI_ERROR_WOULD_WAIT
-    */
+     *  @param handle       Socket handle
+     *  @param address      The remote SocketAddress
+     *  @param data         The packet to be sent
+     *  @param size         The length of the packet to be sent
+     *  @return             The number of written bytes on success, negative on failure
+     *  @note This call is not-blocking, if this call would block, must
+     *        immediately return NSAPI_ERROR_WOULD_WAIT
+     */
     virtual int socket_sendto(void *handle, const SocketAddress &address, const void *data, unsigned size);
 
     /** Receive a packet from a remote endpoint
-    \param handle   Socket handle
-    \param address  Destination for the remote SocketAddress or null
-    \param buffer   The buffer for storing the incoming packet data
-                    If a packet is too long to fit in the supplied buffer,
-                    excess bytes are discarded
-    \param size     The length of the buffer
-    \return the number of received bytes on success, negative on failure
-    \note This call is not-blocking, if this call would block, must
-          immediately return NSAPI_ERROR_WOULD_WAIT
-    */
+     *  @param handle       Socket handle
+     *  @param address      Destination for the remote SocketAddress or null
+     *  @param buffer       The buffer for storing the incoming packet data
+     *                      If a packet is too long to fit in the supplied buffer,
+     *                      excess bytes are discarded
+     *  @param size         The length of the buffer
+     *  @return             The number of received bytes on success, negative on failure
+     *  @note This call is not-blocking, if this call would block, must
+     *        immediately return NSAPI_ERROR_WOULD_WAIT
+     */
     virtual int socket_recvfrom(void *handle, SocketAddress *address, void *buffer, unsigned size);
 
-    /** Close the socket
-    \param handle   Socket handle
-    \param shutdown  free the left-over data in message queues
-    */
-    virtual int socket_close(void *handle, bool shutdown);
-
-    /** Register a callback on when a new connection is ready
-    \param handle   Socket handle
-    \param callback Function to call when accept will succeed, may be called in
-                    interrupt context.
-    \param id       Argument to pass to callback
-    */
-    virtual void socket_attach_accept(void *handle, void (*callback)(void *), void *id);
-
-    /** Register a callback on when send is ready
-    \param handle   Socket handle
-    \param callback Function to call when accept will succeed, may be called in
-                    interrupt context.
-    \param id       Argument to pass to callback
-    */
-    virtual void socket_attach_send(void *handle, void (*callback)(void *), void *id);
-
-    /** Register a callback on when recv is ready
-    \param handle   Socket handle
-    \param callback Function to call when accept will succeed, may be called in
-                    interrupt context.
-    \param id       Argument to pass to callback
-    */
-    virtual void socket_attach_recv(void *handle, void (*callback)(void *), void *id);
+    /** Register a callback on state change of the socket
+     *  @param handle       Socket handle
+     *  @param callback     Function to call on state change
+     *  @param data         Argument to pass to callback
+     *  @note Callback may be called in an interrupt context.
+     */
+    virtual void socket_attach(void *handle, void (*callback)(void *), void *data);
 
 private:
     ESP8266 _esp;
     bool _ids[ESP8266_SOCKET_COUNT];
 };
 
 #endif
-