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

RDAWiFiInterface class Implementation of the NetworkStack for an EMAC-based Ethernet driver. More...

#include <RdaWiFiInterface.h>

Inheritance diagram for RDAWiFiInterface:
EMACInterface WiFiInterface NetworkInterface NetworkInterface DNS DNS

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

 RDAWiFiInterface (EMAC &emac=EMAC::get_default_instance(), OnboardNetworkStack &stack=OnboardNetworkStack::get_default_instance())
 Create an EMAC-based ethernet interface. More...
 
virtual nsapi_error_t set_credentials (const char *ssid, const char *pass, nsapi_security_t security=NSAPI_SECURITY_NONE)
 Set the WiFi network credentials. More...
 
virtual nsapi_error_t set_channel (uint8_t channel)
 Set the WiFi network channel. More...
 
virtual int8_t get_rssi ()
 Gets 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)
 Start the interface. More...
 
virtual nsapi_error_t connect ()
 Start the interface. More...
 
virtual nsapi_error_t disconnect ()
 Stop the interface. More...
 
virtual nsapi_error_t reconnect ()
 Restart the interface. More...
 
virtual nsapi_size_or_error_t scan (WiFiAccessPoint *res, nsapi_size_t count)
 Scan for available networks. More...
 
virtual nsapi_error_t set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway)
 Set a static IP address. More...
 
virtual nsapi_error_t set_dhcp (bool dhcp)
 Enable or disable DHCP on the network. More...
 
virtual const char * get_mac_address ()
 Get the local MAC address. More...
 
virtual nsapi_error_t get_ip_address (SocketAddress *address)
 Get the local IP address. More...
 
virtual nsapi_error_t get_ipv6_link_local_address (SocketAddress *address)
 Get the IPv6 link local address. More...
 
virtual nsapi_error_t get_netmask (SocketAddress *address)
 Get the local network mask. More...
 
virtual nsapi_error_t get_gateway (SocketAddress *address)
 Get the local gateways. More...
 
virtual char * get_interface_name (char *interface_name)
 Get the network interface name. More...
 
virtual void set_as_default ()
 Set the network interface as default one. More...
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Register callback for status reporting. More...
 
virtual nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
virtual nsapi_error_t set_blocking (bool blocking)
 Set blocking status of connect() which by default should be blocking. More...
 
EMACget_emac () const
 Provide access to the EMAC. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. 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...
 
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 EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
virtual CellularInterfacecellularBase ()
 Return pointer to a CellularInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 

Static Public Member Functions

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

Protected Member Functions

virtual NetworkStackget_stack ()
 Provide access to the underlying stack. More...
 

Detailed Description

RDAWiFiInterface class Implementation of the NetworkStack for an EMAC-based Ethernet driver.

Definition at line 30 of file RdaWiFiInterface.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 249 of file NetworkInterface.h.

Constructor & Destructor Documentation

Create an EMAC-based ethernet interface.

The default arguments obtain the default EMAC, which will be target- dependent (and the target may have some JSON option to choose which is the default, if there are multiple). The default stack is configured by JSON option nsapi.default-stack.

Due to inability to return errors from the constructor, no real work is done until the first call to connect().

Parameters
emacReference to EMAC to use
stackReference to onboard-network stack to use

Definition at line 46 of file RdaWiFiInterface.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.

Parameters
status_cbThe callback for status changes

Reimplemented from NetworkInterface.

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 377 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 454 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 
)
virtual

Start the interface.

Attempts to connect to a WiFi 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 on which the connection is to be made, or 0 for any (Default: 0)
Returns
0 on success, or error code on failure

Implements WiFiInterface.

virtual nsapi_error_t connect ( )
virtual

Start the interface.

Attempts to connect to a WiFi network. Requires ssid and passphrase to be set. If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.

Returns
0 on success, negative error code on failure

Reimplemented from EMACInterface.

virtual nsapi_error_t disconnect ( )
virtual

Stop the interface.

Returns
0 on success, or error code on failure

Reimplemented from EMACInterface.

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 from NetworkInterface.

Definition at line 182 of file EMACInterface.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 351 of file NetworkInterface.h.

virtual nsapi_connection_status_t get_connection_status ( ) const
virtualinherited

Get the connection status.

Returns
The connection status according to nsapi_connection_status_t

Reimplemented from NetworkInterface.

static WiFiInterface* get_default_instance ( )
staticinherited

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.
static NetworkInterface* get_default_instance ( )
staticinherited

Return the default network interface.

Returns the default network interface, as determined by JSON option target.network-default-interface-type or other overrides.

The type of the interface returned can be tested by calling ethInterface(), wifiInterface(), meshInterface(), cellularInterface(), emacInterface() and checking for NULL pointers.

The default behavior is to return the default interface for the interface type specified by target.network-default-interface-type. Targets should set this in their targets.json to guide default selection, and applications may override.

The interface returned should be already configured for use such that its connect() method works with no parameters. For connection types needing configuration, settings should normally be obtained from JSON - the settings for the core types are under the "nsapi" JSON config tree.

The list of possible settings for default interface type is open-ended, as is the number of possible providers. Core providers are:

Specific drivers may be activated by other settings of the default-network-interface-type configuration. This will depend on the target and the driver. For example a board may have its default setting as "AUTO" which causes it to autodetect an Ethernet cable. This should be described in the target's documentation.

An application can override all target settings by implementing NetworkInterface::get_default_instance() themselves - the default definition is weak, and calls get_target_default_instance().

EMAC& get_emac ( ) const
inherited

Provide access to the EMAC.

This should be used with care - normally the network stack would control the EMAC, so manipulating the EMAC while the stack is also using it (ie after connect) will likely cause problems.

Returns
Reference to the EMAC in use

Definition at line 177 of file EMACInterface.h.

virtual nsapi_error_t get_gateway ( SocketAddress address)
virtualinherited

Get the local gateways.

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

Reimplemented from NetworkInterface.

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 from NetworkInterface.

virtual nsapi_error_t get_ip_address ( SocketAddress address)
virtualinherited

Get the local IP address.

Returns
Null-terminated representation of the local IP address or null if no IP address has been received

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtualinherited

Get the IPv6 link local address.

SocketAddress representation of the link local IPv6 address

Returns
0 on success, negative error code on failure

Reimplemented from NetworkInterface.

virtual const char* get_mac_address ( )
virtualinherited

Get the local MAC address.

Provided MAC address is intended for info or debug purposes and may not be 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 from NetworkInterface.

virtual nsapi_error_t get_netmask ( SocketAddress address)
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 from NetworkInterface.

virtual int8_t get_rssi ( )
virtual

Gets the current radio signal strength for active connection.

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

Implements WiFiInterface.

virtual NetworkStack* get_stack ( )
protectedvirtualinherited

Provide access to the underlying stack.

Returns
The underlying network stack
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 367 of file NetworkInterface.h.

virtual nsapi_error_t reconnect ( )
virtual

Restart the interface.

Attempts to reconnect to a WiFi network. Ssid and passphrase has been stored.

Returns
0 on success, negative error code on failure
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 
)
virtual

Scan for available networks.

This function will block. If the count is 0, function will only return count of available networks, so that user can allocated necessary memory. If the count is grater than 0 and the a res is not NULL it'll be populated with discovered networks up to value of count.

Parameters
resPointer to allocated array to store discovered AP
countSize of allocated res array, or 0 to only count available AP
Returns
Number of entries in count, or if count was 0 number of available networks, negative on error see nsapi_error

Implements WiFiInterface.

virtual void set_as_default ( )
virtualinherited

Set the network interface as default one.

Reimplemented from NetworkInterface.

virtual nsapi_error_t set_blocking ( bool  blocking)
virtualinherited

Set blocking status of connect() which by default should be blocking.

Parameters
blockingtrue if connect is blocking
Returns
0 on success, negative error code on failure

Reimplemented from NetworkInterface.

Reimplemented in WhdSoftAPInterface, and WhdSTAInterface.

virtual nsapi_error_t set_channel ( uint8_t  channel)
virtual

Set the WiFi network channel.

Parameters
channelChannel on which the connection is to be made, or 0 for any (Default: 0)
Returns
0 on success, or error code on failure

Implements WiFiInterface.

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

Set the WiFi 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
0 on success, or error code on failure

Implements WiFiInterface.

virtual void set_default_parameters ( )
virtualinherited

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 void set_default_parameters ( )
virtualinherited

defined(DOXYGEN_ONLY)

Set default parameters on an interface.

A network interface instantiated directly or using calls such as 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 in CellularInterface, and WiFiInterface.

virtual nsapi_error_t set_dhcp ( bool  dhcp)
virtualinherited

Enable or disable DHCP on the network.

Requires that the network is disconnected

Parameters
dhcpFalse to disable dhcp (defaults to enabled)
Returns
0 on success, negative error code on failure

Reimplemented from NetworkInterface.

virtual nsapi_error_t set_network ( const SocketAddress ip_address,
const SocketAddress netmask,
const SocketAddress gateway 
)
virtualinherited

Set a static IP address.

Configures 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
0 on success, negative error code on failure

Reimplemented from NetworkInterface.

virtual WiFiInterface* wifiInterface ( )
virtualinherited

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.

virtual WiFiInterface* wifiInterface ( )
virtualinherited

Return pointer to a WiFiInterface.

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

Reimplemented in WiFiInterface.

Definition at line 359 of file NetworkInterface.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.