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.

WiFiInterface.h

Committer:
sam_grove
Date:
2016-03-09
Revision:
63:531f4c27f360
Parent:
57:3c873fab4207

File content as of revision 63:531f4c27f360:

/* WiFiInterface Base Class
 * Copyright (c) 2015 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef WIFI_INTERFACE_H
#define WIFI_INTERFACE_H

#include "NetworkInterface.h"

/** Enum for WiFi encryption types
 */
enum ns_security_t {
    NS_SECURITY_NONE = 0,   /*!< open access point */
    NS_SECURITY_WEP,        /*!< phrase conforms to WEP */
    NS_SECURITY_WPA,        /*!< phrase conforms to WPA */
    NS_SECURITY_WPA2,       /*!< phrase conforms to WPA2 */
};


/** WiFiInterface class
 *  Common interface that is shared between WiFi devices
 */
class WiFiInterface : public NetworkInterface
{
public:
    /** 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
     *  @return 0 on success
     */
    virtual int32_t connect(const char *ssid, const char *pass, ns_security_t security = NS_SECURITY_NONE) = 0;

    /** Stop the interface
     *  @return 0 on success
     */
    virtual int32_t disconnect() = 0;
};

#endif