DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

WiFiInterface.h@77:b66a6984ed2d, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 09:16:47 2016 -0500
Revision:
77:b66a6984ed2d
Child:
78:0914f9b9b24b
Integrated interfaces as arguments to sockets

Who changed what in which revision?

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