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

WhdSoftAPInterface class Implementation of the SoftAPInterface for the Whd. More...

#include <WhdSoftAPInterface.h>

Inheritance diagram for WhdSoftAPInterface:
EMACInterface NetworkInterface DNS

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

 WhdSoftAPInterface (WHD_EMAC &emac=WHD_EMAC::get_instance(WHD_AP_ROLE), OnboardNetworkStack &stack=OnboardNetworkStack::get_default_instance(), whd_interface_shared_info_t &shared=whd_iface_shared)
 Construct SoftAP interface. More...
 
int start (const char *ssid, const char *pass, nsapi_security_t security, uint8_t channel, bool start_dhcp_server=true, const whd_custom_ie_info_t *ie_info=NULL, bool ap_sta_concur=false)
 Set static IP address for SoftAP. More...
 
int remove_custom_ie (const whd_custom_ie_info_t *ie_info)
 Remove Wi-Fi custom IE. More...
 
int stop (void)
 Stop the Software Access Point. More...
 
int get_associated_client_list (void *client_list_buffer, uint16_t buffer_length)
 Gets information about associated clients. More...
 
int register_event_handler (whd_event_handler_t softap_event_handler)
 Register soft AP event handler. More...
 
int unregister_event_handler (void)
 Unregister soft AP event handler. More...
 
nsapi_error_t set_blocking (bool blocking)
 Set blocking status of interface. 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...
 
nsapi_error_t connect () override
 Connect to a network. More...
 
nsapi_error_t disconnect () override
 Disconnect from 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...
 
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...
 
void add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Add event listener for 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 CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 

Static Public Member Functions

static WhdSoftAPInterfaceget_default_instance ()
 Get the default WhdSoftAPInterface instance. More...
 

Protected Member Functions

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

Detailed Description

WhdSoftAPInterface class Implementation of the SoftAPInterface for the Whd.

Definition at line 45 of file WhdSoftAPInterface.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.

Constructor & Destructor Documentation

WhdSoftAPInterface ( WHD_EMAC emac = WHD_EMAC::get_instance(WHD_AP_ROLE),
OnboardNetworkStack stack = OnboardNetworkStack::get_default_instance(),
whd_interface_shared_info_t shared = whd_iface_shared 
)

Construct SoftAP interface.

Returns
pointer to default WhdSoftAPInterface instance

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 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 ( )
overridevirtualinherited

Connect to a network.

This blocks until connection is established, but asynchronous operation can be enabled by calling NetworkInterface::set_blocking(false).

In asynchronous mode this starts the connection sequence and returns immediately. Status of the connection can then checked from NetworkInterface::get_connection_status() or from status callbacks.

NetworkInterface internally handles reconnections until disconnect() is called.

Returns
NSAPI_ERROR_OK if connection established in blocking mode.
NSAPI_ERROR_OK if asynchronous operation started.
NSAPI_ERROR_BUSY if asynchronous operation cannot be started. Implementation guarantees event generation, which can be used as an trigger to reissue the rejected request.
NSAPI_ERROR_IS_CONNECTED if already connected.
negative error code on failure.

Implements NetworkInterface.

nsapi_error_t disconnect ( )
overridevirtualinherited

Disconnect from the network.

This blocks until interface is disconnected, unless interface is set to asynchronous (non-blocking) mode by calling NetworkInterface::set_blocking(false).

Returns
NSAPI_ERROR_OK on successfully disconnected in blocking mode.
NSAPI_ERROR_OK if asynchronous operation started.
NSAPI_ERROR_BUSY if asynchronous operation cannot be started. Implementation guarantees event generation, which can be used as an trigger to reissue the rejected request.
NSAPI_ERROR_NO_CONNECTION if already disconnected.
negative error code on failure.

Implements NetworkInterface.

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

int get_associated_client_list ( void *  client_list_buffer,
uint16_t  buffer_length 
)

Gets information about associated clients.

Note
Only applicable if softAP interface is up
Parameters
[out]client_list_buffer: pointer to a buffer that will be populated with a variable length structure defined by whd_maclist_t
[in]buffer_length: length of the buffer
Returns
0 on success, or error code on failure see nsapi_error
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.

static WhdSoftAPInterface* get_default_instance ( )
static

Get the default WhdSoftAPInterface instance.

Returns
pointer to default WhdSoftAPInterface instance
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.

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.

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.

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.

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.

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.

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 register_event_handler ( whd_event_handler_t  softap_event_handler)

Register soft AP event handler.

Parameters
[in]softap_event_handler: A function pointer to the event handler
Returns
0 on success, or error code on failure see nsapi_error
int remove_custom_ie ( const whd_custom_ie_info_t ie_info)

Remove Wi-Fi custom IE.

Parameters
[in]ie_info: Pointer to the structure which contains custom IE information
Returns
0 on success, or error code on failure see nsapi_error
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 142 of file WhdSoftAPInterface.h.

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 WiFiInterface, and CellularInterface.

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.

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.

int start ( const char *  ssid,
const char *  pass,
nsapi_security_t  security,
uint8_t  channel,
bool  start_dhcp_server = true,
const whd_custom_ie_info_t ie_info = NULL,
bool  ap_sta_concur = false 
)

Set static IP address for SoftAP.

Configures the static IP address of SoftAP Requires that the network is stopped.

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 int set_network(const char *ip_address, const char *netmask, const char *gateway);Start a SoftAP
Parameters
ssidName of the SoftAP to create
passSecurity passphrase for connection to SoftAP
securityType of encryption for connection
channelChannel for SoftAP
start_dhcp_serverStart dhcp server for connection
whd_custom_ieOptional Custom IE
ap_sta_concurEnable STA+AP concurrency mode
Returns
0 on success, or error code on failure see nsapi_error
int stop ( void  )

Stop the Software Access Point.

Returns
0 on success, or error code on failure see nsapi_error
int unregister_event_handler ( void  )

Unregister soft AP event handler.

Returns
0 on success, or error code on failure see nsapi_error
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 406 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.