Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Public Types | Public Member Functions | Protected Member Functions
WhdSTAInterface Class Referenceabstract

WhdSTAInterface class Implementation of the NetworkStack for the WHD. More...

#include <WhdSTAInterface.h>

Inheritance diagram for WhdSTAInterface:
WiFiInterface EMACInterface NetworkInterface NetworkInterface DNS DNS

Data Structures

class  OlmInterface
 

Public Types

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

Public Member Functions

nsapi_error_t connect ()
 Start the interface. More...
 
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...
 
nsapi_error_t disconnect ()
 Stop the interface. More...
 
nsapi_error_t set_credentials (const char *ssid, const char *pass, nsapi_security_t security=NSAPI_SECURITY_NONE)
 Set the WiFi network credentials. More...
 
nsapi_error_t set_channel (uint8_t channel)
 Set the WiFi network channel - NOT SUPPORTED. More...
 
nsapi_error_t set_blocking (bool blocking)
 Set blocking status of interface. More...
 
int8_t get_rssi ()
 Gets the current radio signal strength for active connection. More...
 
int scan (WiFiAccessPoint *res, unsigned count)
 Scan for available networks in WiFiAccessPoint format. More...
 
int scan_whd (WhdAccessPoint *res, unsigned count)
 Scan for available networks in WhdAccessPoint format. More...
 
int set_olm (OlmInterface *olm)
 Set Offload Manager Information NOTE: Only allowed while disconnected. More...
 
int net_suspended ()
 Network stack is suspended. More...
 
int net_resuming ()
 Network stack is resuming. More...
 
virtual nsapi_size_or_error_t scan (WiFiAccessPoint *res, nsapi_size_t count)=0
 Scan for available networks. More...
 
WiFiInterfacewifiInterface () final
 Return pointer to a WiFiInterface. More...
 
void set_default_parameters () override
 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 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 gateway. More...
 
virtual char * get_interface_name (char *interface_name)
 Get the network interface name. More...
 
virtual nsapi_error_t set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &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 getaddrinfo (const char *hostname, SocketAddress *hints, SocketAddress **res, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses 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_value_or_error_t getaddrinfo_async (const char *hostname, SocketAddress *hints, hostbyname_cb_t callback, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses (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 nsapi_error_t get_dns_server (int index, SocketAddress *address, const char *interface_name=NULL)
 Get a domain name server from a 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...
 
virtual nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
virtual EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
nsapi_error_t set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway) override
 Set a static IP address. More...
 
nsapi_error_t set_dhcp (bool dhcp) override
 Enable or disable DHCP on the network. More...
 
const char * get_mac_address () override
 Get the local MAC address. More...
 
nsapi_error_t get_ip_address (SocketAddress *address) override
 Get the local IP address. More...
 
nsapi_error_t get_ipv6_link_local_address (SocketAddress *address) override
 Get the IPv6 link local address. More...
 
nsapi_error_t get_netmask (SocketAddress *address) override
 Get the local network mask. More...
 
nsapi_error_t get_gateway (SocketAddress *address) override
 Get the local gateway. More...
 
char * get_interface_name (char *interface_name) override
 Get the network interface name. More...
 
void set_as_default () override
 Set network interface as default one. More...
 
void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) override
 Register callback for status reporting. More...
 
nsapi_connection_status_t get_connection_status () const override
 Get the connection status. More...
 
EMACget_emac () const
 Provide access to the EMAC. More...
 
EMACInterfaceemacInterface () final
 Return pointer to an EMACInterface. More...
 

Protected Member Functions

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

Detailed Description

WhdSTAInterface class Implementation of the NetworkStack for the WHD.

Definition at line 34 of file WhdSTAInterface.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_value_or_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
resultNegative error code on failure or value that represents the number of DNS records
addressOn success, destination for the host SocketAddress.

Definition at line 258 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.
void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
overridevirtualinherited

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

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, InterfaceNanostack, L3IPInterface, EMACInterface, PPPInterface, and AT_CellularContext.

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 430 of file NetworkInterface.h.

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

Implements WiFiInterface.

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)
channelThis parameter is not supported, setting it to anything else than 0 will result in NSAPI_ERROR_UNSUPPORTED
Returns
0 on success, or error code on failure

Implements WiFiInterface.

nsapi_error_t disconnect ( )
virtual

Stop the interface.

Returns
0 on success, negative on failure

Implements WiFiInterface.

EMACInterface* emacInterface ( )
finalvirtualinherited

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 128 of file EMACInterface.h.

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 422 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 398 of file NetworkInterface.h.

nsapi_connection_status_t get_connection_status ( ) const
overridevirtualinherited

Get the connection status.

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

Reimplemented from NetworkInterface.

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 InterfaceNanostack, L3IPInterface, EMACInterface, PPPInterface, and AT_CellularContext.

virtual nsapi_error_t get_dns_server ( int  index,
SocketAddress address,
const char *  interface_name = NULL 
)
virtualinherited

Get a domain name server from a list of servers to query.

Returns a DNS server address for a index. If returns error no more DNS servers to read.

Parameters
indexIndex of the DNS server, starts from zero
addressDestination for the host address
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure
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 123 of file EMACInterface.h.

nsapi_error_t get_gateway ( SocketAddress address)
overridevirtualinherited

Get the local gateway.

Parameters
addressSocketAddress representation of gateway address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_gateway ( SocketAddress address)
virtualinherited

Get the local gateway.

Parameters
addressSocketAddress representation of gateway address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and UBLOX_AT_CellularContext.

char* get_interface_name ( char *  interface_name)
overridevirtualinherited

Get the network interface name.

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

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 in EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

nsapi_error_t get_ip_address ( SocketAddress address)
overridevirtualinherited

Get the local IP address.

Parameters
addressSocketAddress representation of the local IP address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_ip_address ( SocketAddress address)
virtualinherited

Get the local IP address.

Parameters
addressSocketAddress representation of the local IP address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

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

nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
overridevirtualinherited

Get the IPv6 link local address.

Parameters
addressSocketAddress representation of the link local IPv6 address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtualinherited

Get the IPv6 link local address.

Parameters
addressSocketAddress representation of the link local IPv6 address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid

Reimplemented in EMACInterface.

const char* get_mac_address ( )
overridevirtualinherited

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

nsapi_error_t get_netmask ( SocketAddress address)
overridevirtualinherited

Get the local network mask.

Parameters
addressSocketAddress representation of netmask
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_netmask ( SocketAddress address)
virtualinherited

Get the local network mask.

Parameters
addressSocketAddress representation of netmask
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

int8_t get_rssi ( )
virtual

Gets the current radio signal strength for active connection.

Returns
Connection strength in dBm (negative value)

Implements WiFiInterface.

NetworkStack* get_stack ( )
finalprotectedinherited

Provide access to the underlying stack.

Returns
The underlying network stack
virtual nsapi_value_or_error_t getaddrinfo ( const char *  hostname,
SocketAddress hints,
SocketAddress **  res,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to the multiple IP addresses 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
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
resPointer to a SocketAddress array to store the result..
interface_nameNetwork interface name
Returns
number of results on success, negative error code on failure.

Implements DNS.

virtual nsapi_value_or_error_t getaddrinfo_async ( const char *  hostname,
SocketAddress hints,
hostbyname_cb_t  callback,
const char *  interface_name = NULL 
)
virtualinherited

Translate a hostname to the multiple IP addresses (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
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
callbackCallback that is called for result.
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 ( 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
Return values
NSAPI_ERROR_OKon success
intNegative error code on failure. See NetworkStack::gethostbyname

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 414 of file NetworkInterface.h.

int net_resuming ( )

Network stack is resuming.

Returns
0 if successful

Definition at line 245 of file WhdSTAInterface.h.

int net_suspended ( )

Network stack is suspended.

Returns
0 if successful

Definition at line 235 of file WhdSTAInterface.h.

virtual nsapi_size_or_error_t scan ( WiFiAccessPoint res,
nsapi_size_t  count 
)
pure virtualinherited

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.

int scan ( WiFiAccessPoint res,
unsigned  count 
)

Scan for available networks in WiFiAccessPoint format.

This function will block.

Parameters
apPointer to allocated array of WiFiAccessPoint format for discovered AP
countSize of allocated res array, or 0 to only count available AP
timeoutTimeout in milliseconds; 0 for no timeout (Default: 0)
Returns
Number of entries in , or if count was 0 number of available networks, negative on error see nsapi_error
int scan_whd ( WhdAccessPoint res,
unsigned  count 
)

Scan for available networks in WhdAccessPoint format.

This function will block.

Parameters
apPointer to allocated array of WhdAccessPoint format for discovered AP
countSize of allocated res array, or 0 to only count available AP
timeoutTimeout in milliseconds; 0 for no timeout (Default: 0)
Returns
Number of entries in , or if count was 0 number of available networks, negative on error see nsapi_error
virtual void set_as_default ( )
virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

void set_as_default ( )
overridevirtualinherited

Set network interface as default one.

Reimplemented from NetworkInterface.

nsapi_error_t set_blocking ( bool  blocking)
virtual

Set blocking status of interface.

Nonblocking mode unsupported.

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

Reimplemented from NetworkInterface.

Definition at line 128 of file WhdSTAInterface.h.

nsapi_error_t set_channel ( uint8_t  channel)
virtual

Set the WiFi network channel - NOT SUPPORTED.

This function is not supported and will return NSAPI_ERROR_UNSUPPORTED

Parameters
channelChannel on which the connection is to be made, or 0 for any (Default: 0)
Returns
Not supported, returns NSAPI_ERROR_UNSUPPORTED

Implements WiFiInterface.

Definition at line 113 of file WhdSTAInterface.h.

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.

void set_default_parameters ( )
overridevirtualinherited

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.

nsapi_error_t set_dhcp ( bool  dhcp)
overridevirtualinherited

Enable or disable DHCP on the network.

Requires that the network is disconnected

Parameters
dhcpFalse to disable dhcp (defaults to enabled)
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_UNSUPPORTEDif operation is not supported.

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.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_UNSUPPORTEDif operation is not supported.

Reimplemented in EMACInterface, and L3IPInterface.

nsapi_error_t set_network ( const SocketAddress ip_address,
const SocketAddress netmask,
const SocketAddress gateway 
)
overridevirtualinherited

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_addressSocketAddress representation of the local IP address
netmaskSocketAddress representation of the local network mask
gatewaySocketAddress representation of the local gateway
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

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_addressSocketAddress object containing the local IP address
netmaskSocketAddress object containing the local network mask
gatewaySocketAddress object containing the local gateway
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this function is unsupported

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

int set_olm ( OlmInterface olm)

Set Offload Manager Information NOTE: Only allowed while disconnected.

Parameters
olmOffload Manager info structure
Returns
true if completed successfully false if Interface is connected

Definition at line 222 of file WhdSTAInterface.h.

WiFiInterface* wifiInterface ( )
finalvirtualinherited

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.