WhdSTAInterface class Implementation of the NetworkStack for the WHD. More...
#include <WhdSTAInterface.h>
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... | |
WiFiInterface * | wifiInterface () 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 EthInterface * | ethInterface () |
Return pointer to an EthInterface. More... | |
virtual MeshInterface * | meshInterface () |
Return pointer to a MeshInterface. More... | |
virtual EMACInterface * | emacInterface () |
Return pointer to an EMACInterface. More... | |
virtual CellularInterface * | cellularInterface () |
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... | |
EMAC & | get_emac () const |
Provide access to the EMAC. More... | |
EMACInterface * | emacInterface () final |
Return pointer to an EMACInterface. More... | |
Protected Member Functions | |
NetworkStack * | get_stack () final |
Provide access to the underlying stack. More... | |
WhdSTAInterface class Implementation of the NetworkStack for the WHD.
Definition at line 34 of file WhdSTAInterface.h.
|
inherited |
Hostname translation callback (for use with gethostbyname_async()).
Callback will be called after DNS resolution completes or a failure occurs.
result | Negative error code on failure or value that represents the number of DNS records |
address | On success, destination for the host SocketAddress. |
Definition at line 259 of file NetworkInterface.h.
|
virtualinherited |
Add a domain name server to list of servers to query.
address | Address for the dns host. |
Implements DNS.
|
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.
status_cb | The callback for status changes. |
|
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.
status_cb | The callback for status changes. |
Reimplemented from NetworkInterface.
|
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.
status_cb | The callback for status changes. |
Reimplemented in CellularContext, InterfaceNanostack, L3IPInterface, EMACInterface, PPPInterface, and AT_CellularContext.
|
virtualinherited |
Return pointer to a CellularInterface.
Reimplemented in CellularInterface.
Definition at line 431 of file NetworkInterface.h.
|
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.
Implements WiFiInterface.
|
virtual |
Start the interface.
Attempts to connect to a WiFi network.
ssid | Name of the network to connect to |
pass | Security passphrase to connect to the network |
security | Type of encryption for connection (Default: NSAPI_SECURITY_NONE) |
channel | This parameter is not supported, setting it to anything else than 0 will result in NSAPI_ERROR_UNSUPPORTED |
Implements WiFiInterface.
|
virtual |
|
finalvirtualinherited |
Return pointer to an EMACInterface.
Reimplemented from NetworkInterface.
Definition at line 129 of file EMACInterface.h.
|
virtualinherited |
Return pointer to an EMACInterface.
Reimplemented in EMACInterface.
Definition at line 423 of file NetworkInterface.h.
|
virtualinherited |
Return pointer to an EthInterface.
Reimplemented in EthInterface.
Definition at line 399 of file NetworkInterface.h.
|
overridevirtualinherited |
Get the connection status.
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the connection status.
Reimplemented in InterfaceNanostack, L3IPInterface, EMACInterface, PPPInterface, and AT_CellularContext.
|
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.
index | Index of the DNS server, starts from zero |
address | Destination for the host address |
interface_name | Network interface name |
|
inherited |
|
overridevirtualinherited |
Get the local gateway.
address | SocketAddress representation of gateway address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the local gateway.
address | SocketAddress representation of gateway address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and UBLOX_AT_CellularContext.
|
overridevirtualinherited |
Get the network interface name.
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the network interface name.
Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.
|
overridevirtualinherited |
Get the local IP address.
address | SocketAddress representation of the local IP address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the local IP address.
address | SocketAddress representation of the local IP address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented in CellularContext, InterfaceNanostack, CellularInterface, EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.
|
overridevirtualinherited |
Get the IPv6 link local address.
address | SocketAddress representation of the link local IPv6 address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the IPv6 link local address.
address | SocketAddress representation of the link local IPv6 address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
Reimplemented in EMACInterface.
|
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.
Reimplemented from NetworkInterface.
|
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.
Reimplemented in InterfaceNanostack, and EMACInterface.
|
overridevirtualinherited |
Get the local network mask.
address | SocketAddress representation of netmask |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the local network mask.
address | SocketAddress representation of netmask |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
|
virtual |
Gets the current radio signal strength for active connection.
Implements WiFiInterface.
|
finalprotectedinherited |
Provide access to the underlying stack.
|
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.
hostname | Hostname to resolve. |
hints | Pointer to a SocketAddress with query parameters. |
res | Pointer to a SocketAddress array to store the result.. |
interface_name | Network interface name |
Implements DNS.
|
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.
hostname | Hostname to resolve. |
hints | Pointer to a SocketAddress with query parameters. |
callback | Callback that is called for result. |
interface_name | Network interface name |
Implements DNS.
|
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.
host | Hostname to resolve. |
address | Pointer to a SocketAddress to store the result. |
version | IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC). |
interface_name | Network interface name |
NSAPI_ERROR_OK | on success |
int | Negative error code on failure. See NetworkStack::gethostbyname |
Implements DNS.
|
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.
host | Hostname to resolve. |
callback | Callback that is called for result. |
version | IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC). |
interface_name | Network interface name |
Implements DNS.
|
virtualinherited |
Cancel asynchronous hostname translation.
When translation is cancelled, callback will not be called.
id | Unique id of the hostname translation operation (returned by gethostbyname_async) |
Implements DNS.
|
virtualinherited |
Return pointer to a MeshInterface.
Reimplemented in MeshInterface.
Definition at line 415 of file NetworkInterface.h.
int net_resuming | ( | ) |
int net_suspended | ( | ) |
Network stack is suspended.
Definition at line 235 of file WhdSTAInterface.h.
|
pure virtualinherited |
Scan for available networks.
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
.
res | Pointer to allocated array to store discovered APs. |
count | Size of allocated res array, or 0 to only count available APs. |
Implemented in RDAWiFiInterface.
int scan | ( | WiFiAccessPoint * | res, |
unsigned | count | ||
) |
Scan for available networks in WiFiAccessPoint format.
This function will block.
ap | Pointer to allocated array of WiFiAccessPoint format for discovered AP |
count | Size of allocated res array, or 0 to only count available AP |
timeout | Timeout in milliseconds; 0 for no timeout (Default: 0) |
int scan_whd | ( | WhdAccessPoint * | res, |
unsigned | count | ||
) |
Scan for available networks in WhdAccessPoint format.
This function will block.
ap | Pointer to allocated array of WhdAccessPoint format for discovered AP |
count | Size of allocated res array, or 0 to only count available AP |
timeout | Timeout in milliseconds; 0 for no timeout (Default: 0) |
|
virtualinherited |
Set network interface as default one.
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
|
overridevirtualinherited |
Set network interface as default one.
Reimplemented from NetworkInterface.
|
virtual |
Set blocking status of interface.
Nonblocking mode unsupported.
blocking | true if connect is blocking |
Reimplemented from NetworkInterface.
Definition at line 128 of file WhdSTAInterface.h.
|
virtual |
Set the WiFi network channel - NOT SUPPORTED.
This function is not supported and will return NSAPI_ERROR_UNSUPPORTED
channel | Channel on which the connection is to be made, or 0 for any (Default: 0) |
Implements WiFiInterface.
Definition at line 113 of file WhdSTAInterface.h.
|
virtual |
Set the WiFi network credentials.
ssid | Name of the network to connect to |
pass | Security passphrase to connect to the network |
security | Type of encryption for connection (defaults to NSAPI_SECURITY_NONE) |
Implements WiFiInterface.
|
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.
|
overridevirtualinherited |
Enable or disable DHCP on the network.
Requires that the network is disconnected
dhcp | False to disable dhcp (defaults to enabled) |
NSAPI_ERROR_OK | on success. |
NSAPI_ERROR_UNSUPPORTED | if operation is not supported. |
Reimplemented from NetworkInterface.
|
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.
dhcp | True to enable DHCP. |
NSAPI_ERROR_OK | on success. |
NSAPI_ERROR_UNSUPPORTED | if operation is not supported. |
Reimplemented in EMACInterface, and L3IPInterface.
|
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.
ip_address | SocketAddress representation of the local IP address |
netmask | SocketAddress representation of the local network mask |
gateway | SocketAddress representation of the local gateway |
Reimplemented from NetworkInterface.
|
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.
ip_address | SocketAddress object containing the local IP address |
netmask | SocketAddress object containing the local network mask |
gateway | SocketAddress object containing the local gateway |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this function is unsupported |
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
int set_olm | ( | OlmInterface * | olm | ) |
Set Offload Manager Information NOTE: Only allowed while disconnected.
olm | Offload Manager info structure |
Definition at line 222 of file WhdSTAInterface.h.
|
finalvirtualinherited |
Return pointer to a WiFiInterface.
Reimplemented from NetworkInterface.
Definition at line 110 of file WiFiInterface.h.