DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

WiFiInterface.h@104:d28d8b508e7c, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:26:21 2016 -0500
Revision:
104:d28d8b508e7c
Parent:
89:b1d417383c0d 
Revised documentation for Interface classes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 104:d28d8b508e7c 1 /* WiFiInterface
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 104:d28d8b508e7c 22 /** Enum of WiFi encryption types
Christopher Haster 104:d28d8b508e7c 23 *
Christopher Haster 104:d28d8b508e7c 24 * The security type specifies a particular security to use when
Christopher Haster 104:d28d8b508e7c 25 * connected to a WiFi network
Christopher Haster 104:d28d8b508e7c 26 *
Christopher Haster 104:d28d8b508e7c 27 * @enum nsapi_protocol_t
Christopher Haster 89:b1d417383c0d 28 */
Christopher Haster 89:b1d417383c0d 29 enum nsapi_security_t {
Christopher Haster 89:b1d417383c0d 30 NSAPI_SECURITY_NONE = 0, /*!< open access point */
Christopher Haster 89:b1d417383c0d 31 NSAPI_SECURITY_WEP, /*!< phrase conforms to WEP */
Christopher Haster 89:b1d417383c0d 32 NSAPI_SECURITY_WPA, /*!< phrase conforms to WPA */
Christopher Haster 89:b1d417383c0d 33 NSAPI_SECURITY_WPA2, /*!< phrase conforms to WPA2 */
Christopher Haster 89:b1d417383c0d 34 };
Christopher Haster 89:b1d417383c0d 35
Christopher Haster 89:b1d417383c0d 36 /** WiFiInterface class
Christopher Haster 104:d28d8b508e7c 37 *
Christopher Haster 89:b1d417383c0d 38 * Common interface that is shared between WiFi devices
Christopher Haster 89:b1d417383c0d 39 */
Christopher Haster 89:b1d417383c0d 40 class WiFiInterface : public NetworkInterface
Christopher Haster 89:b1d417383c0d 41 {
Christopher Haster 89:b1d417383c0d 42 public:
Christopher Haster 89:b1d417383c0d 43 /** Start the interface
Christopher Haster 104:d28d8b508e7c 44 *
Christopher Haster 104:d28d8b508e7c 45 * Attempts to connect to a WiFi network. If passphrase is invalid,
Christopher Haster 104:d28d8b508e7c 46 * NSAPI_ERROR_AUTH_ERROR is returned.
Christopher Haster 104:d28d8b508e7c 47 *
Christopher Haster 89:b1d417383c0d 48 * @param ssid Name of the network to connect to
Christopher Haster 89:b1d417383c0d 49 * @param pass Security passphrase to connect to the network
Christopher Haster 89:b1d417383c0d 50 * @param security Type of encryption for connection
Christopher Haster 104:d28d8b508e7c 51 * @return 0 on success, negative error code on failure
Christopher Haster 89:b1d417383c0d 52 */
Christopher Haster 89:b1d417383c0d 53 virtual int connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE) = 0;
Christopher Haster 89:b1d417383c0d 54
Christopher Haster 89:b1d417383c0d 55 /** Stop the interface
Christopher Haster 104:d28d8b508e7c 56 *
Christopher Haster 104:d28d8b508e7c 57 * @return 0 on success, negative error code on failure
Christopher Haster 89:b1d417383c0d 58 */
Christopher Haster 89:b1d417383c0d 59 virtual int disconnect() = 0;
Christopher Haster 89:b1d417383c0d 60 };
Christopher Haster 89:b1d417383c0d 61
Christopher Haster 89:b1d417383c0d 62 #endif