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.
WiFiInterface.h@89:b1d417383c0d, 2016-04-19 (annotated)
- Committer:
- Christopher Haster
- Date:
- Tue Apr 19 18:20:38 2016 -0500
- Revision:
- 89:b1d417383c0d
- Parent:
- 88:6cfd38609828
- Child:
- 104:d28d8b508e7c
Adopt mbed style doxygen comments
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Christopher Haster |
89:b1d417383c0d | 1 | /* Socket |
| Christopher Haster |
89:b1d417383c0d | 2 | * Copyright (c) 2015 ARM Limited |
| Christopher Haster |
89:b1d417383c0d | 3 | * |
| Christopher Haster |
89:b1d417383c0d | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| Christopher Haster |
89:b1d417383c0d | 5 | * you may not use this file except in compliance with the License. |
| Christopher Haster |
89:b1d417383c0d | 6 | * You may obtain a copy of the License at |
| Christopher Haster |
89:b1d417383c0d | 7 | * |
| Christopher Haster |
89:b1d417383c0d | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| Christopher Haster |
89:b1d417383c0d | 9 | * |
| Christopher Haster |
89:b1d417383c0d | 10 | * Unless required by applicable law or agreed to in writing, software |
| Christopher Haster |
89:b1d417383c0d | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| Christopher Haster |
89:b1d417383c0d | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| Christopher Haster |
89:b1d417383c0d | 13 | * See the License for the specific language governing permissions and |
| Christopher Haster |
89:b1d417383c0d | 14 | * limitations under the License. |
| Christopher Haster |
89:b1d417383c0d | 15 | */ |
| Christopher Haster |
89:b1d417383c0d | 16 | |
| Christopher Haster |
89:b1d417383c0d | 17 | #ifndef WIFI_INTERFACE_H |
| Christopher Haster |
89:b1d417383c0d | 18 | #define WIFI_INTERFACE_H |
| Christopher Haster |
89:b1d417383c0d | 19 | |
| Christopher Haster |
89:b1d417383c0d | 20 | #include "NetworkInterface.h" |
| Christopher Haster |
89:b1d417383c0d | 21 | |
| Christopher Haster |
89:b1d417383c0d | 22 | /** Enum for WiFi encryption types |
| Christopher Haster |
89:b1d417383c0d | 23 | */ |
| Christopher Haster |
89:b1d417383c0d | 24 | enum nsapi_security_t { |
| Christopher Haster |
89:b1d417383c0d | 25 | NSAPI_SECURITY_NONE = 0, /*!< open access point */ |
| Christopher Haster |
89:b1d417383c0d | 26 | NSAPI_SECURITY_WEP, /*!< phrase conforms to WEP */ |
| Christopher Haster |
89:b1d417383c0d | 27 | NSAPI_SECURITY_WPA, /*!< phrase conforms to WPA */ |
| Christopher Haster |
89:b1d417383c0d | 28 | NSAPI_SECURITY_WPA2, /*!< phrase conforms to WPA2 */ |
| Christopher Haster |
89:b1d417383c0d | 29 | }; |
| Christopher Haster |
89:b1d417383c0d | 30 | |
| Christopher Haster |
89:b1d417383c0d | 31 | /** WiFiInterface class |
| Christopher Haster |
89:b1d417383c0d | 32 | * Common interface that is shared between WiFi devices |
| Christopher Haster |
89:b1d417383c0d | 33 | */ |
| Christopher Haster |
89:b1d417383c0d | 34 | class WiFiInterface : public NetworkInterface |
| Christopher Haster |
89:b1d417383c0d | 35 | { |
| Christopher Haster |
89:b1d417383c0d | 36 | public: |
| Christopher Haster |
89:b1d417383c0d | 37 | /** Start the interface |
| Christopher Haster |
89:b1d417383c0d | 38 | * @param ssid Name of the network to connect to |
| Christopher Haster |
89:b1d417383c0d | 39 | * @param pass Security passphrase to connect to the network |
| Christopher Haster |
89:b1d417383c0d | 40 | * @param security Type of encryption for connection |
| Christopher Haster |
89:b1d417383c0d | 41 | * @return 0 on success, negative on failure |
| Christopher Haster |
89:b1d417383c0d | 42 | */ |
| Christopher Haster |
89:b1d417383c0d | 43 | virtual int connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE) = 0; |
| Christopher Haster |
89:b1d417383c0d | 44 | |
| Christopher Haster |
89:b1d417383c0d | 45 | /** Stop the interface |
| Christopher Haster |
89:b1d417383c0d | 46 | * @return 0 on success, negative on failure |
| Christopher Haster |
89:b1d417383c0d | 47 | */ |
| Christopher Haster |
89:b1d417383c0d | 48 | virtual int disconnect() = 0; |
| Christopher Haster |
89:b1d417383c0d | 49 | }; |
| Christopher Haster |
89:b1d417383c0d | 50 | |
| Christopher Haster |
89:b1d417383c0d | 51 | #endif |