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.

Committer:
Christopher Haster
Date:
Thu Feb 18 03:11:58 2016 -0600
Branch:
api-changes
Revision:
21:35ed15069189
Parent:
13:f84e69b3fdd3
Child:
26:9774a2edad71
Added UDPSocket and TCPSocket API and changes to core API

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 7:b147c08301be 1 /* WiFiInterface Base Class
sam_grove 7:b147c08301be 2 * Copyright (c) 2015 ARM Limited
sam_grove 7:b147c08301be 3 *
sam_grove 7:b147c08301be 4 * Licensed under the Apache License, Version 2.0 (the "License");
sam_grove 7:b147c08301be 5 * you may not use this file except in compliance with the License.
sam_grove 7:b147c08301be 6 * You may obtain a copy of the License at
sam_grove 7:b147c08301be 7 *
sam_grove 7:b147c08301be 8 * http://www.apache.org/licenses/LICENSE-2.0
sam_grove 7:b147c08301be 9 *
sam_grove 7:b147c08301be 10 * Unless required by applicable law or agreed to in writing, software
sam_grove 7:b147c08301be 11 * distributed under the License is distributed on an "AS IS" BASIS,
sam_grove 7:b147c08301be 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sam_grove 7:b147c08301be 13 * See the License for the specific language governing permissions and
sam_grove 7:b147c08301be 14 * limitations under the License.
sam_grove 7:b147c08301be 15 */
sam_grove 7:b147c08301be 16
Christopher Haster 21:35ed15069189 17 #ifndef WIFI_INTERFACE_H
Christopher Haster 21:35ed15069189 18 #define WIFI_INTERFACE_H
sam_grove 7:b147c08301be 19
sam_grove 7:b147c08301be 20 #include "NetworkInterface.h"
sam_grove 7:b147c08301be 21
Christopher Haster 21:35ed15069189 22 /** Enum for WiFi encryption types
sam_grove 7:b147c08301be 23 */
sam_grove 7:b147c08301be 24 typedef enum wifi_security_t {
sam_grove 7:b147c08301be 25 WI_NONE = 0, /*!< No security for connection */
sam_grove 7:b147c08301be 26 WI_WEP, /*!< WEP encryption */
sam_grove 7:b147c08301be 27 WI_WPA, /*!< WPA encryption */
sam_grove 7:b147c08301be 28 WI_WPA2, /*!< WPA2 encryption */
sam_grove 7:b147c08301be 29 } wifi_security_t;
sam_grove 7:b147c08301be 30
Christopher Haster 21:35ed15069189 31
Christopher Haster 21:35ed15069189 32 /** WiFiInterface class
Christopher Haster 21:35ed15069189 33 * Common interface that is shared between WiFi devices
sam_grove 7:b147c08301be 34 */
sam_grove 7:b147c08301be 35 class WiFiInterface : public NetworkInterface
sam_grove 7:b147c08301be 36 {
sam_grove 7:b147c08301be 37 public:
sam_grove 7:b147c08301be 38
Christopher Haster 21:35ed15069189 39 /** Start the interface
Christopher Haster 21:35ed15069189 40 * @param ssid Name of the network to connect to
Christopher Haster 21:35ed15069189 41 * @param pass Security passphrase to connect to the network
Christopher Haster 21:35ed15069189 42 * @param security Type of encryption to connect with
Christopher Haster 21:35ed15069189 43 * @param timeout_ms Time in milliseconds to wait for a connection
Christopher Haster 21:35ed15069189 44 * @return 0 on success
sam_grove 7:b147c08301be 45 */
Christopher Haster 21:35ed15069189 46 virtual int32_t connect(
Christopher Haster 21:35ed15069189 47 const char *ssid,
Christopher Haster 21:35ed15069189 48 const char *pass,
Christopher Haster 21:35ed15069189 49 wifi_security_t security = WI_NONE,
Christopher Haster 21:35ed15069189 50 uint32_t timeout_ms = 15000) = 0;
Christopher Haster 21:35ed15069189 51
Christopher Haster 21:35ed15069189 52 /** Stop the interface
Christopher Haster 21:35ed15069189 53 * @return 0 on success
Christopher Haster 21:35ed15069189 54 */
Christopher Haster 21:35ed15069189 55 virtual int32_t disconnect() = 0;
sam_grove 7:b147c08301be 56 };
sam_grove 7:b147c08301be 57
sam_grove 7:b147c08301be 58 #endif