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

result	NSAPI_ERROR_OK on success, negative error code on failure.
address	On success, destination for the host SocketAddress.

Definition at line 219 of file NetworkInterface.h.

Construct SoftAP interface.

Returns

pointer to default WhdSoftAPInterface instance

Add a domain name server to list of servers to query.

Parameters

address

Address for the dns host.

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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_cb

The callback for status changes.

Register callback for status reporting.

Parameters

status_cb

The callback for status changes

Reimplemented from NetworkInterface.

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

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

Start the interface.

Returns

0 on success, negative on failure

Implements NetworkInterface.

Reimplemented in RDAWiFiInterface, and WhdSTAInterface.

Stop the interface.

Returns

0 on success, negative on failure

Implements NetworkInterface.

Reimplemented in RDAWiFiInterface, and WhdSTAInterface.

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.

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

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

Get the connection status.

Returns

The connection status according to nsapi_connection_status_t

Reimplemented from NetworkInterface.

Get the default WhdSoftAPInterface instance.

Returns

pointer to default WhdSoftAPInterface instance

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.

Get the local gateways.

Returns

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

Reimplemented from NetworkInterface.

Get the network interface name.

Returns

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

Reimplemented from NetworkInterface.

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.

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.

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.

Provide access to the underlying stack.

Returns

The underlying network stack

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

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

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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

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

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.

Cancel asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters

id	Unique id of the hostname translation operation (returned by gethostbyname_async)

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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

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

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

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters

status_cb

The callback to unregister.

Set the network interface as default one.

Reimplemented from NetworkInterface.

Set blocking status of interface.

Nonblocking mode unsupported.

Parameters

blocking

true if connect is blocking

Returns

0 on success, negative error code on failure

Reimplemented from EMACInterface.

Definition at line 142 of file WhdSoftAPInterface.h.

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.

Enable or disable DHCP on the network.

Requires that the network is disconnected

Parameters

dhcp	False to disable dhcp (defaults to enabled)

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

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_address	Null-terminated representation of the local IP address
netmask	Null-terminated representation of the local network mask
gateway	Null-terminated representation of the local gateway

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

Set static IP address for SoftAP.

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

Parameters

ip_address	Null-terminated representation of the local IP address
netmask	Null-terminated representation of the local network mask
gateway	Null-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

ssid	Name of the SoftAP to create
pass	Security passphrase for connection to SoftAP
security	Type of encryption for connection
channel	Channel for SoftAP
start_dhcp_server	Start dhcp server for connection
whd_custom_ie	Optional Custom IE
ap_sta_concur	Enable STA+AP concurrency mode

Returns

0 on success, or error code on failure see nsapi_error

Stop the Software Access Point.

Returns

0 on success, or error code on failure see nsapi_error

Unregister soft AP event handler.

Returns

0 on success, or error code on failure see nsapi_error

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