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

Revision:
89:b1d417383c0d
Parent:
81:1600369a29dd
Child:
90:0a988e4abb72
--- a/TCPSocket.h	Wed Apr 06 13:50:19 2016 +0000
+++ b/TCPSocket.h	Tue Apr 19 18:20:38 2016 -0500
@@ -20,76 +20,75 @@
 #include "Socket.h"
 #include "NetworkInterface.h"
 
-/**
-TCP socket connection
-*/
+/** TCP socket connection
+ */
 class TCPSocket : public Socket {
 public:
     /** TCP socket lifetime
-    */
+     */
     TCPSocket(NetworkInterface *iface);
     virtual ~TCPSocket();
     
     /** Connects this TCP socket to the server
-    \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 host's port to connect to
-    \return         0 on success, negative on failure
-    */
+     *  @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 host's port to connect to
+     *  @return         0 on success, negative on failure
+     */
     int connect(const char *host, uint16_t port);
 
     /** Connects this TCP socket to the server
-    \param address  SocketAddress to connect to
-    \return         0 on success, negative on failure
-    */
+     *  @param address  SocketAddress to connect to
+     *  @return         0 on success, negative on failure
+     */
     int connect(const SocketAddress &address);
     
     /** Check if the socket is connected
-    \return         true if connected, false otherwise
-    */
+     *  @return         true if connected, false otherwise
+     */
     bool is_connected();
     
     /** Send data to the remote host
-    \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
-    */
+     *  @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
+     */
     int send(const void *data, unsigned size);
     
     /** Receive data from the remote host
-    \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
-    */
+     *  @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
+     */
     int recv(void *data, 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:
     friend class TCPServer;
 
-    mbed::FuncPtr<void()> _send_cb;
-    mbed::FuncPtr<void()> _recv_cb;
+    FunctionPointer _send_cb;
+    FunctionPointer _recv_cb;
 };
 
 #endif