Base class for IP Based Networking Libraries

Dependencies:   DnsQuery

Dependents:   TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more

Embed: (wiki syntax)

« Back to documentation index

WiFiInterface Class Reference

WiFiInterface Class Reference

WiFiInterface class. More...

#include <WiFiInterface.h>

Public Member Functions

virtual int connect (const char *ssid, const char *pass, nsapi_security_t security=NSAPI_SECURITY_NONE)=0
 Start the interface.
virtual int disconnect ()=0
 Stop the interface.
virtual const char * get_mac_address ()=0
 Get the local MAC address.

Detailed Description

WiFiInterface class.

Common interface that is shared between WiFi devices

Definition at line 40 of file WiFiInterface.h.


Member Function Documentation

virtual int connect ( const char *  ssid,
const char *  pass,
nsapi_security_t  security = NSAPI_SECURITY_NONE 
) [pure virtual]

Start the interface.

Attempts to connect to a WiFi network. If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.

Parameters:
ssidName of the network to connect to
passSecurity passphrase to connect to the network
securityType of encryption for connection
Returns:
0 on success, negative error code on failure
virtual int disconnect (  ) [pure virtual]

Stop the interface.

Returns:
0 on success, negative error code on failure
virtual const char* get_mac_address (  ) [pure virtual]

Get the local MAC address.

Returns:
Null-terminated representation of the local MAC address