NetworkSocketAPI / NetworkSocketAPI

Base class for IP Based Networking Libraries

Dependencies:   DnsQuery

Dependents:   TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more

For a complete getting started guide see the wiki...

Network Socket API

The Network Socket API provides a common interface for using sockets on network devices. The API provides a simple class-based interface that should be familiar to users experienced with other socket APIs. Additionally, the API provides a simple interface for implementing network devices, making it easy to connect hardware agnostic programs to new devices.

Network Interfaces

The NetworkInterface provides an abstract class for network devices that support sockets. Devices should provide a DeviceInterface class that inherits this interface and adds implementation specific methods for using the device. A NetworkInterface must be provided to a Socket constructor to open a socket on the interface. Currently two subclasses are defined for common devices, EthernetInterface and WiFiInterface.

Sockets

The Socket class is used for managing network sockets. Once opened, the socket provides a pipe through which data can sent and recieved to a specific endpoint. The socket class can be instantiated as either a TCPSocket or a UDPSocket which defines the protocol used for the connection.

Diff: TCPSocket.h

Branch:
api-changes
Revision:
25:ed7b2a52e8ac
Parent:
24:a5e959bdd2dd
Child:
27:d7ed39727306
--- a/TCPSocket.h	Thu Feb 18 04:09:00 2016 -0600
+++ b/TCPSocket.h	Thu Feb 18 06:01:55 2016 -0600
@@ -17,13 +17,13 @@
 #ifndef TCP_SOCKET_H
 #define TCP_SOCKET_H
 
-#include "NetworkInterface.h"
+#include "Socket.h"
 
 /** TCPSocket class
  *  API for handling TCP sockets. The implementation is determined
  *  by the interface passed during construction.
  */
-class TCPSocket
+class TCPSocket : public Socket
 {
 public:
     /** Create a socket using the specified network interface
@@ -33,37 +33,6 @@
      */
     TCPSocket(NetworkInterface *iface, const char *url = 0, uint16_t port = 0);
 
-    /** Closes and destroys the socket
-     */
-    ~TCPSocket();
-
-
-    /** Set the URL of the socket
-     *  Performs DNS lookup if necessary
-     *  @param url URL to connect to
-     */
-    void setURL(const char *url);
-
-    /** Set the IP address of the socket
-     *  @param ip IP address to connect to, copied internally
-     */
-    void setIPAddress(const char *ip);
-
-    /** Set the port of the socket
-     *  @param port Port to connect to
-     */
-    void setPort(uint16_t port);
-
-    /** Gets the IP address
-     *  @return IP address to connect to
-     */
-    const char *getIPAddress();
-
-    /** Gets the port
-     *  @return Port to connect to
-     */
-    uint16_t getPort();
-
 
     /** Open a connection to the underlying address
      *  @return 0 on success
@@ -74,26 +43,6 @@
      *  @return 0 on success
      */
     int32_t close();
-
-    /** Send data over TCP 
-     *  @param data Buffer of data to send
-     *  @param len Size of data to send
-     *  @param timeout_ms Maximum amount of time to wait
-     *  @return 0 on success
-     */
-    int32_t send(const void *data, uint32_t len, uint32_t timeout_ms = 15000);
-
-    /** Recieve data over TCP
-     *  @param data Buffer to store recieved data
-     *  @param len Size of provided buffer
-     *  @param timeout_ms Maximum amount of time to wait
-     *  @return Number of bytes sent or a negative value on failure
-     */
-    int32_t recv(void *data, uint32_t len, uint32_t timeout_ms = 15000);
-
-private:
-    NetworkInterface *_iface;
-    SocketInterface *_socket;
 };
 
 #endif