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: UDPSocket.h

Revision:
96:656011e49d9f
Parent:
92:dd5f19874adf
Child:
98:0f614f1d0398
--- a/UDPSocket.h	Tue Apr 19 18:24:24 2016 -0500
+++ b/UDPSocket.h	Tue Apr 19 18:24:34 2016 -0500
@@ -40,6 +40,29 @@
      */
     int bind(uint16_t port);
 
+    /** Bind a UDP Server Socket to a local address
+     *  @param address  The null-terminated address to listen for incoming connections on
+     *  @param port     The port to listen for incoming connections on
+     *  @return         0 on success, negative on failure.
+     */
+    int bind(const char *address, uint16_t port);
+
+    /** Bind a UDP Server Socket to a local address
+     *  @param address  The SocketAddress to listen for incoming connections on
+     *  @return         0 on success, negative on failure.
+     */
+    int bind(const SocketAddress &address);
+
+    /** Send a packet to a remote endpoint
+     *  @param host     The host to connect to. It can either be an IP Address
+     *                  or a hostname that will be resolved with DNS
+     *  @param port     The remote port
+     *  @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
+     */
+    int sendto(const char *host, uint16_t port, const void *data, unsigned size);
+
     /** Send a packet to a remote endpoint
      *  @param address  The remote SocketAddress
      *  @param data     The packet to be sent