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:
89:b1d417383c0d
Parent:
81:1600369a29dd
Child:
90:0a988e4abb72
--- a/UDPSocket.h	Wed Apr 06 13:50:19 2016 +0000
+++ b/UDPSocket.h	Tue Apr 19 18:20:38 2016 -0500
@@ -20,65 +20,64 @@
 #include "Socket.h"
 #include "NetworkInterface.h"
 
-/**
-UDP Socket
-*/
+/** UDP Socket
+ */
 class UDPSocket : public Socket {
 public:
     /** UDPSocket lifetime
-    */
+     */
     UDPSocket(NetworkInterface *iface);
     virtual ~UDPSocket();
     
     /** Bind a UDP Server Socket to a specific port
-    \param port The port to listen for incoming connections on
-    \return 0 on success, negative on failure.
-    */
+     *  @param port     The port to listen for incoming connections on
+     *  @return         0 on success, negative on failure.
+     */
     int bind(uint16_t port);
 
     /** Send a packet to a remote endpoint
-    \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
-    */
+     *  @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
+     */
     int sendto(const SocketAddress &address, const void *data, unsigned size);
 
     /** Receive a packet from a remote endpoint
-    \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
-    */
+     *  @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
+     */
     int recvfrom(SocketAddress *address, 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
-                    interrupt context.
-    */
-    void attach_send(mbed::FuncPtr<void()> callback);
+     *  @param callback Function to call when send will succeed, may be called in
+     *                  interrupt context.
+     */
+    void attach_send(FunctionPointer callback);
 
     template <typename T, typename M>
     void attach_send(T *tptr, M mptr) {
-        attach_send(mbed::FuncPtr<void()>(tptr, mptr));
+        attach_send(FunctionPointer(tptr, mptr));
     }
 
     /** Register a callback on when recv is ready
-    \param callback Function to call when recv will succeed, may be called in
-                    interrupt context.
-    */
-    void attach_recv(mbed::FuncPtr<void()> callback);
+     *  @param callback Function to call when recv will succeed, may be called in
+     *                  interrupt context.
+     */
+    void attach_recv(FunctionPointer callback);
 
     template <typename T, typename M>
     void attach_recv(T *tptr, M mptr) {
-        attach_recv(mbed::FuncPtr<void()>(tptr, mptr));
+        attach_recv(FunctionPointer(tptr, mptr));
     }
 
 private:
-    mbed::FuncPtr<void()> _send_cb;
-    mbed::FuncPtr<void()> _recv_cb;
+    FunctionPointer _send_cb;
+    FunctionPointer _recv_cb;
 };
 
 #endif