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:
74:ef2470ca328b
Parent:
73:968f7b32278f
Child:
75:dea0cdb42241
--- a/UDPSocket.h	Tue Apr 05 05:47:57 2016 -0500
+++ b/UDPSocket.h	Tue Apr 05 06:22:10 2016 -0500
@@ -39,22 +39,24 @@
     
     /** Send a packet to a remote endpoint
     \param addr     The remote IP address
-    \param remote   The remote port
+    \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 (>=0) or -1 on failure
+    \return the number of written bytes on success, negative on failure
     */
     int sendto(const char *addr, uint16_t port, const void *data, unsigned size);
     
     /** Receive a packet from a remote endpoint
-    \param addr     The remote IP address
+    \param addr     The buffer to store the remote IP address or null.
+                    The buffer must be at least NS_IP_SIZE large.
+    \param port     The destination for the remote port 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
     */
-    int recvfrom(const char *addr, uint16_t port, void *buffer, unsigned size);
+    int recvfrom(char *addr, uint16_t *port, void *buffer, unsigned size);
 
     /** Register a callback on when send is ready
     \param callback Function to call when send will succeed, may be called in