Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Static Public Member Functions
WiFiInterface Class Referenceabstract

Common interface between Wi-Fi devices. More...

#include <WiFiInterface.h>

Inheritance diagram for WiFiInterface:
NetworkInterface DNS RDAWiFiInterface WhdSTAInterface

Public Types

typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t
 Hostname translation callback (for use with gethostbyname_async()). More...
 

Public Member Functions

virtual nsapi_error_t set_credentials (const char *ssid, const char *pass, nsapi_security_t security=NSAPI_SECURITY_NONE)=0
 Set the Wi-Fi network credentials. More...
 
virtual nsapi_error_t set_channel (uint8_t channel)=0
 Set the Wi-Fi network channel. More...
 
virtual int8_t get_rssi ()=0
 Get the current radio signal strength for active connection. More...
 
virtual nsapi_error_t connect (const char *ssid, const char *pass, nsapi_security_t security=NSAPI_SECURITY_NONE, uint8_t channel=0)=0
 Attempt to connect to a Wi-Fi network. More...
 
virtual nsapi_error_t connect ()=0
 Attempt to connect to a Wi-Fi network. More...
 
virtual nsapi_error_t disconnect ()=0
 Stop the interface. More...
 
virtual nsapi_size_or_error_t scan (WiFiAccessPoint *res, nsapi_size_t count)=0
 Scan for available networks. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 
virtual void set_as_default ()
 Set network interface as default one. More...
 
virtual const char * get_mac_address ()
 Get the local MAC address. More...
 
virtual const char * get_ip_address ()
 Get the local IP address. More...
 
virtual const char * get_netmask ()
 Get the local network mask. More...
 
virtual const char * get_gateway ()
 Get the local gateway. More...
 
virtual char * get_interface_name (char *interface_name)
 Get the network interface name. More...
 
virtual nsapi_error_t set_network (const char *ip_address, const char *netmask, const char *gateway)
 Configure this network interface to use a static IP address. More...
 
virtual nsapi_error_t set_dhcp (bool dhcp)
 Enable or disable DHCP on connecting the network. More...
 
virtual nsapi_error_t gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)
 Translate a hostname to an IP address with specific version using network interface name. More...
 
virtual nsapi_value_or_error_t gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC, const char *interface_name=NULL)
 Translate a hostname to an IP address (asynchronous) using network interface name. More...
 
virtual nsapi_error_t gethostbyname_async_cancel (int id)
 Cancel asynchronous hostname translation. More...
 
virtual nsapi_error_t add_dns_server (const SocketAddress &address, const char *interface_name)
 Add a domain name server to list of servers to query. More...
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Register callback for status reporting. More...
 
void add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Add event listener for interface. More...
 
void remove_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Remove event listener from interface. More...
 
virtual nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
virtual nsapi_error_t set_blocking (bool blocking)
 Set asynchronous operation of connect() and disconnect() calls. More...
 
virtual EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
virtual CellularInterfacecellularBase ()
 Return pointer to a CellularInterface. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 

Static Public Member Functions

static WiFiInterfaceget_default_instance ()
 Get the default Wi-Fi interface. More...
 

Detailed Description

Common interface between Wi-Fi devices.

Definition at line 31 of file WiFiInterface.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t
inherited

Hostname translation callback (for use with gethostbyname_async()).

Callback will be called after DNS resolution completes or a failure occurs.

Note
Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.
Parameters
resultNSAPI_ERROR_OK on success, negative error code on failure.
addressOn success, destination for the host SocketAddress.

Definition at line 219 of file NetworkInterface.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address,
const char *  interface_name 
)
virtualinherited

Add a domain name server to list of servers to query.

Parameters
addressAddress for the dns host.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

void add_event_listener ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
inherited

Add event listener for interface.

This API allows multiple callback to be registered for a single interface. When first called, internal list of event handlers are created and registered to interface through attach() API.

Application may only use attach() or add_event_listener() interface. Mixing usage of both leads to undefined behavior.

Parameters
status_cbThe callback for status changes.
virtual void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
virtualinherited

Register callback for status reporting.

The specified status callback function will be called on status changes on the network. The parameters on the callback are the event type and event-type dependent reason parameter. Only one callback can be registered at a time.

To unregister a callback call with status_cb parameter as a zero.

NOTE: Any callbacks registered with this function will be overwritten if add_event_listener() API is used.

Parameters
status_cbThe callback for status changes.

Reimplemented in CellularContext, EMACInterface, L3IPInterface, InterfaceNanostack, PPPInterface, and AT_CellularContext.

virtual CellularInterface* cellularBase ( )
virtualinherited

Return pointer to a CellularInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.
Deprecated:
CellularBase migrated to CellularInterface - use cellularInterface()

Reimplemented in CellularInterface.

Definition at line 347 of file NetworkInterface.h.

virtual CellularInterface* cellularInterface ( )
virtualinherited

Return pointer to a CellularInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in CellularInterface.

Definition at line 424 of file NetworkInterface.h.

virtual nsapi_error_t connect ( const char *  ssid,
const char *  pass,
nsapi_security_t  security = NSAPI_SECURITY_NONE,
uint8_t  channel = 0 
)
pure virtual

Attempt to connect to a Wi-Fi network.

Parameters
ssidName of the network to connect to.
passSecurity passphrase to connect to the network.
securityType of encryption for connection (Default: NSAPI_SECURITY_NONE).
channelChannel to make the connection, or 0 for any (Default: 0).
Returns
NSAPI_ERROR_OK on success, or error code on failure.

Implemented in RDAWiFiInterface, and WhdSTAInterface.

virtual nsapi_error_t connect ( )
pure virtual

Attempt to connect to a Wi-Fi network.

Requires ssid and passphrase to be set. If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.

Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements NetworkInterface.

Implemented in RDAWiFiInterface, and WhdSTAInterface.

virtual nsapi_error_t disconnect ( )
pure virtual

Stop the interface.

Returns
NSAPI_ERROR_OK on success, or error code on failure.

Implements NetworkInterface.

Implemented in RDAWiFiInterface, and WhdSTAInterface.

virtual EMACInterface* emacInterface ( )
virtualinherited

Return pointer to an EMACInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in EMACInterface.

Definition at line 355 of file NetworkInterface.h.

virtual EthInterface* ethInterface ( )
virtualinherited

Return pointer to an EthInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in EthInterface.

Definition at line 321 of file NetworkInterface.h.

virtual nsapi_connection_status_t get_connection_status ( ) const
virtualinherited

Get the connection status.

Returns
The connection status (
See also
nsapi_types.h).

Reimplemented in EMACInterface, L3IPInterface, InterfaceNanostack, PPPInterface, and AT_CellularContext.

static WiFiInterface* get_default_instance ( )
static

Get the default Wi-Fi interface.

This is provided as a weak method so applications can override it. Default behavior is to get the target's default interface, if any.

Returns
pointer to interface, if any.
virtual const char* get_gateway ( )
virtualinherited

Get the local gateway.

Returns
Null-terminated representation of the local gateway or null if no network mask has been received.

Reimplemented in CellularContext, EMACInterface, CellularInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

virtual char* get_interface_name ( char *  interface_name)
virtualinherited

Get the network interface name.

Returns
Null-terminated representation of the network interface name or null if interface not exists

Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

virtual const char* get_ip_address ( )
virtualinherited

Get the local IP address.

Returns
Null-terminated representation of the local IP address or null if not yet connected

Reimplemented in CellularContext, InterfaceNanostack, EMACInterface, CellularInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

virtual const char* get_mac_address ( )
virtualinherited

Get the local MAC address.

Provided MAC address is intended for info or debug purposes and may be not provided if the underlying network interface does not provide a MAC address.

Returns
Null-terminated representation of the local MAC address or null if no MAC address is available.

Reimplemented in InterfaceNanostack, and EMACInterface.

virtual const char* get_netmask ( )
virtualinherited

Get the local network mask.

Returns
Null-terminated representation of the local network mask or null if no network mask has been received.

Reimplemented in CellularContext, EMACInterface, CellularInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

virtual int8_t get_rssi ( )
pure virtual

Get the current radio signal strength for active connection.

Returns
Connection strength in dBm (negative value), or 0 if measurement impossible.

Implemented in WhdSTAInterface, and RDAWiFiInterface.

virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to an IP address with specific version using network interface name.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Parameters
hostHostname to resolve.
addressPointer to a SocketAddress to store the result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

virtual nsapi_value_or_error_t gethostbyname_async ( const char *  host,
hostbyname_cb_t  callback,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to an IP address (asynchronous) using network interface name.

The hostname may be either a domain name or a dotted IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case result is success (IP address was found from DNS cache), callback will be called before function returns.

Parameters
hostHostname to resolve.
callbackCallback that is called for result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork interface name
Returns
0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel.

Implements DNS.

virtual nsapi_error_t gethostbyname_async_cancel ( int  id)
virtualinherited

Cancel asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters
idUnique id of the hostname translation operation (returned by gethostbyname_async)
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

virtual MeshInterface* meshInterface ( )
virtualinherited

Return pointer to a MeshInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented in MeshInterface.

Definition at line 337 of file NetworkInterface.h.

void remove_event_listener ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
inherited

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters
status_cbThe callback to unregister.
virtual nsapi_size_or_error_t scan ( WiFiAccessPoint res,
nsapi_size_t  count 
)
pure virtual

Scan for available networks.

Note
This is a blocking function.

If the count is 0, the function only returns the number of available networks. If the count is greater than 0 and the res is not NULL, the array of discovered APs is populated with discovered networks up to the value of the count.

Parameters
resPointer to allocated array to store discovered APs.
countSize of allocated res array, or 0 to only count available APs.
Returns
Number of entries in res, or if count was 0, number of available networks. Negative on error (
See also
nsapi_types.h for nsapi_error).

Implemented in RDAWiFiInterface.

virtual void set_as_default ( )
virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

virtual nsapi_error_t set_blocking ( bool  blocking)
virtualinherited

Set asynchronous operation of connect() and disconnect() calls.

By default, interfaces are in synchronous mode which means that connect() or disconnect() blocks until it reach the target state or requested operation fails.

Parameters
blockingUse false to set NetworkInterface in asynchronous mode.
Returns
NSAPI_ERROR_OK on success
NSAPI_ERROR_UNSUPPORTED if driver does not support asynchronous mode.
negative error code on failure.

Reimplemented in EMACInterface, WhdSoftAPInterface, L3IPInterface, InterfaceNanostack, WhdSTAInterface, PPPInterface, CellularContext, and AT_CellularContext.

virtual nsapi_error_t set_channel ( uint8_t  channel)
pure virtual

Set the Wi-Fi network channel.

Parameters
channelChannel to make the connection, or 0 for any (Default: 0).
Returns
NSAPI_ERROR_OK on success, or error code on failure.

Implemented in WhdSTAInterface, and RDAWiFiInterface.

virtual nsapi_error_t set_credentials ( const char *  ssid,
const char *  pass,
nsapi_security_t  security = NSAPI_SECURITY_NONE 
)
pure virtual

Set the Wi-Fi network credentials.

Parameters
ssidName of the network to connect to.
passSecurity passphrase to connect to the network.
securityType of encryption for connection (defaults to NSAPI_SECURITY_NONE).
Returns
NSAPI_ERROR_OK on success, or error code on failure.

Implemented in WhdSTAInterface, and RDAWiFiInterface.

virtual void set_default_parameters ( )
virtual

defined(DOXYGEN_ONLY)

Set default parameters on a Wi-Fi interface.

A Wi-Fi interface instantiated directly or using WiFiInterface::get_default_instance() is initially unconfigured. This call can be used to set the default parameters that would have been set if the interface had been requested using NetworkInterface::get_default_instance() (see nsapi JSON configuration).

Reimplemented from NetworkInterface.

virtual nsapi_error_t set_dhcp ( bool  dhcp)
virtualinherited

Enable or disable DHCP on connecting the network.

Enabled by default unless a static IP address has been assigned. Requires that the network is disconnected.

Parameters
dhcpTrue to enable DHCP.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in EMACInterface, and L3IPInterface.

virtual nsapi_error_t set_network ( const char *  ip_address,
const char *  netmask,
const char *  gateway 
)
virtualinherited

Configure this network interface to use a static IP address.

Implicitly disables DHCP, which can be enabled in set_dhcp. Requires that the network is disconnected.

Parameters
ip_addressNull-terminated representation of the local IP address
netmaskNull-terminated representation of the local network mask
gatewayNull-terminated representation of the local gateway
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

virtual WiFiInterface* wifiInterface ( )
virtual

Return pointer to a WiFiInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.

Reimplemented from NetworkInterface.

Definition at line 109 of file WiFiInterface.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.