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_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())
 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)
 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...
 
virtual nsapi_error_t set_network (const char *ip_address, const char *netmask, const char *gateway)
 Set a static IP address. More...
 
virtual nsapi_error_t set_dhcp (bool dhcp)
 Enable or disable DHCP on the network. More...
 
virtual nsapi_error_t connect ()
 Start the interface. More...
 
virtual nsapi_error_t disconnect ()
 Stop the interface. More...
 
virtual const char * get_mac_address ()
 Get the local MAC address. More...
 
virtual const char * get_ip_address ()
 Get the local IP address. More...
 
virtual const char * get_netmask ()
 Get the local network mask. More...
 
virtual const char * get_gateway ()
 Get the local 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...
 

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

WhdSoftAPInterface class Implementation of the SoftAPInterface for the Whd.

Definition at line 42 of file WhdSoftAPInterface.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 218 of file NetworkInterface.h.

Constructor & Destructor Documentation

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

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

virtual nsapi_error_t connect ( )
virtualinherited

Start the interface.

Returns
0 on success, negative on failure

Implements NetworkInterface.

Reimplemented in RDAWiFiInterface, and WhdSTAInterface.

virtual nsapi_error_t disconnect ( )
virtualinherited

Stop the interface.

Returns
0 on success, negative on failure

Implements NetworkInterface.

Reimplemented in RDAWiFiInterface, and WhdSTAInterface.

virtual EMACInterface* emacInterface ( )
virtualinherited

Return pointer to an EMACInterface.

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

Reimplemented from NetworkInterface.

Definition at line 163 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 320 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
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 WhdSoftAPInterface* get_default_instance ( )
static

Get the default WhdSoftAPInterface instance.

Returns
pointer to default WhdSoftAPInterface 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 158 of file EMACInterface.h.

virtual const char* get_gateway ( )
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 const char* get_ip_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 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 const char* get_netmask ( )
virtualinherited

Get the local network mask.

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

Reimplemented from NetworkInterface.

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

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 char *  ip_address,
const char *  netmask,
const char *  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.

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 
)

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
[in]OptionalCustom IE
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 328 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.