This is LWIPBP3595Interface class library. The base library is LWIPInterface.

Dependents:   LWIPBP3595Interface_STA

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers LWIPBP3595Interface.h Source File

LWIPBP3595Interface.h

00001 /* LWIPBP3595Interface.h */
00002 /* Copyright (C) 2016 Grape Systems, Inc. */
00003 /* The base file is LWIPInterface.h. */
00004 
00005 /* LWIPInterface.h */
00006 /* LWIP implementation of NetworkInterfaceAPI
00007  * Copyright (c) 2015 ARM Limited
00008  *
00009  * Licensed under the Apache License, Version 2.0 (the "License");
00010  * you may not use this file except in compliance with the License.
00011  * You may obtain a copy of the License at
00012  *
00013  *     http://www.apache.org/licenses/LICENSE-2.0
00014  *
00015  * Unless required by applicable law or agreed to in writing, software
00016  * distributed under the License is distributed on an "AS IS" BASIS,
00017  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00018  * See the License for the specific language governing permissions and
00019  * limitations under the License.
00020  */
00021 
00022 #ifndef LWIP_BP3595_INTERFACE_H
00023 #define LWIP_BP3595_INTERFACE_H
00024 
00025 #include "LWIPInterface.h"
00026 #include "WiFiInterface.h"
00027 
00028 
00029 /** LWIPBP3595Interface class
00030  *  Implementation of the NetworkInterface for LWIP
00031  */
00032 class LWIPBP3595Interface : public LWIPInterface
00033 {
00034 public:
00035 
00036     /** Start the interface
00037      *  @param ssid Name of the network to connect to
00038      *  @param pass Security passphrase to connect to the network
00039      *  @param security Type of encryption to connect with
00040      *  @return 0 on success
00041      */
00042     virtual int connect(
00043         const char *ssid,
00044         const char *pass,
00045         nsapi_security_t security = NSAPI_SECURITY_WPA2);
00046 
00047     virtual int disconnect();
00048 
00049     /** Get the internally stored IP address
00050      *  @return             IP address of the interface or null if not yet connected
00051      */
00052     virtual const char *get_ip_address();
00053  
00054     /** Get the internally stored MAC address
00055      *  @return             MAC address of the interface
00056      */
00057     virtual const char *get_mac_address();
00058 
00059 private:
00060     // Implementation of EthernetInterface
00061     virtual int connect() {return 0;}
00062 
00063 };
00064 
00065 
00066 #endif