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.

Files at this revision

API Documentation at this revision

Comitter:
Christopher Haster
Date:
Tue Apr 05 06:56:22 2016 -0500
Parent:
74:ef2470ca328b
Child:
76:bbe51641f405
Commit message:
Introduced SocketAddress class for efficient handling of netork addresses

Changed in this revision

Socket.h Show annotated file Show diff for this revision Revisions of this file
SocketAddress.h Show annotated file Show diff for this revision Revisions of this file
TCPServer.h Show annotated file Show diff for this revision Revisions of this file
TCPSocket.h Show annotated file Show diff for this revision Revisions of this file
UDPSocket.h Show annotated file Show diff for this revision Revisions of this file
--- a/Socket.h	Tue Apr 05 06:22:10 2016 -0500
+++ b/Socket.h	Tue Apr 05 06:56:22 2016 -0500
@@ -20,7 +20,7 @@
 
 /** Maximum storage needed for IP addresses
  */
-#define NS_API_SIZE 16
+#define NS_API_SIZE 40
 
 /**
  *  @enum ns_error_t
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SocketAddress.h	Tue Apr 05 06:56:22 2016 -0500
@@ -0,0 +1,52 @@
+/* Copyright (C) 2012 mbed.org, MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+#ifndef SOCKETADDRESS_H
+#define SOCKETADDRESS_H
+
+/**
+ * A general socket address composed of the IP address and port
+ */
+class SocketAddress {
+public:
+    /** SocketAddress lifetime 
+     */
+    SocketAddress(const char *addr, uint16_t port);
+    ~SocketAddress();
+   
+    /** Set the IP address
+    \param host Null-terminated string representing the IP address
+     */
+    void set_address(const char *host);
+
+    /** Set the port
+    \param port 16-bit port
+     */
+    void set_port(uint16_t port);
+    
+    /** Get the IP address
+    \return The string representation of the IP Address
+     */
+    const char *get_address();
+    
+    /** Get the port
+    \return The 16-bit port
+     */
+    int get_port(void);
+};
+
+#endif
--- a/TCPServer.h	Tue Apr 05 06:22:10 2016 -0500
+++ b/TCPServer.h	Tue Apr 05 06:56:22 2016 -0500
@@ -47,7 +47,7 @@
     \param socket   A TCPSocket instance that will handle the incoming connection.
     \return         0 on success, negative on failure.
     */
-    int accept(TCPSocket &connection);
+    int accept(TCPSocket *connection);
 
     /** Register a callback on when a new connection is ready
     \param callback Function to call when accept will succeed, may be called in
--- a/TCPSocket.h	Tue Apr 05 06:22:10 2016 -0500
+++ b/TCPSocket.h	Tue Apr 05 06:56:22 2016 -0500
@@ -38,6 +38,12 @@
     \return         0 on success, negative on failure
     */
     int connect(const char* host, const int port);
+
+    /** Connects this TCP socket to the server
+    \param address  SocketAddress to connect to
+    \return         0 on success, negative on failure
+    */
+    int connect(SocketAddress address);
     
     /** Check if the socket is connected
     \return         true if connected, false otherwise
--- a/UDPSocket.h	Tue Apr 05 06:22:10 2016 -0500
+++ b/UDPSocket.h	Tue Apr 05 06:56:22 2016 -0500
@@ -36,27 +36,24 @@
     \return 0 on success, negative on failure.
     */
     int bind(int port);
-    
+
     /** Send a packet to a remote endpoint
-    \param addr     The remote IP address
-    \param port     The remote port
+    \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 char *addr, uint16_t port, const void *data, unsigned size);
-    
+    int sendto(SocketAddress address, const void *data, unsigned size);
+
     /** Receive a packet from a remote endpoint
-    \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 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(char *addr, uint16_t *port, void *buffer, unsigned size);
+    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