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

Branch:
api-changes
Revision:
21:35ed15069189
Parent:
13:f84e69b3fdd3
Child:
26:9774a2edad71
--- a/WiFiInterface.h	Fri Dec 25 19:51:33 2015 +0000
+++ b/WiFiInterface.h	Thu Feb 18 03:11:58 2016 -0600
@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-#ifndef WIFIINTERFACE_H
-#define WIFIINTERFACE_H
+#ifndef WIFI_INTERFACE_H
+#define WIFI_INTERFACE_H
 
 #include "NetworkInterface.h"
 
-/* wifi_security_t enum for encryption types
+/** Enum for WiFi encryption types
  */
 typedef enum wifi_security_t {
     WI_NONE = 0,    /*!< No security for connection */
@@ -28,25 +28,31 @@
     WI_WPA2,        /*!< WPA2 encryption */
 } wifi_security_t;
 
-/** WiFiInterface class.
-    This is a common interface to handle how WiFi connects to an access point
+
+/** WiFiInterface class
+ *  Common interface that is shared between WiFi devices
  */
 class WiFiInterface : public NetworkInterface
 {
 public:
 
-    // make sure to import the base symbol that needs an implementation for classes that have ap and phrase in the constructor
-    using NetworkInterface::connect;
-        
-    /** Start the interface using ap name, phrase and security attributes
-        @param ap Name of the network the radio should connect to
-        @param pass_pharase The security phrase needed for connecting to the network
-        @param security Type of encryption the network requires for connection
-        @param timeout_ms Time in miliseconds to wait while attempting to connect before timing out
-        @returns 0 on success, a negative number on failure
+    /** Start the interface
+     *  @param ssid Name of the network to connect to
+     *  @param pass Security passphrase to connect to the network
+     *  @param security Type of encryption to connect with
+     *  @param timeout_ms Time in milliseconds to wait for a connection
+     *  @return 0 on success
      */
-    virtual int32_t connect(const char *ap, const char *pass_phrase = 0, wifi_security_t security = WI_NONE, uint32_t timeout_ms = 15000)  = 0;
-    
+    virtual int32_t connect(
+            const char *ssid,
+            const char *pass,
+            wifi_security_t security = WI_NONE,
+            uint32_t timeout_ms = 15000) = 0;
+
+    /** Stop the interface
+     *  @return 0 on success
+     */
+    virtual int32_t disconnect() = 0;
 };
 
 #endif