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

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.

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_cb

The callback for status changes.

Reimplemented from NetworkInterface.

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_cb

The callback for status changes.

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

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

Starts the interface.

Attempts to connect to a Wi-Fi 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.

Starts the interface.

Attempts to connect to a Wi-Fi network.

Parameters

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 a value other than 0 will result in NSAPI_ERROR_UNSUPPORTED.

Returns

0 on success, negative error code on failure.

Implements WiFiInterface.

Disconnects the interface.

Returns

0 on success, negative error code on failure.

Implements WiFiInterface.

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

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

Gets the BSSID (MAC address of device connected to).

Parameters

bssid

Pointer to the BSSID value.

Returns

SCL_SUCCESS if BSSID is obtained successfully.

SCL_BADARG if input parameter is NULL.

SCL_ERROR if unable to fetch BSSID.

Get the connection status.

Returns

The connection status (

See also

nsapi_types.h).

Reimplemented from NetworkInterface.

Get the connection status.

Returns

The connection status (

See also

nsapi_types.h).

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

Gets the current instance of the SclSTAInterface.

Returns

Pointer to the object of class SclSTAInterface.

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

index	Index of the DNS server, starts from zero
address	Destination for the host address
interface_name	Network interface name

Returns

NSAPI_ERROR_OK on success, negative error code on failure

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

Get the local gateway.

Parameters

address

SocketAddress representation of gateway address

Return values

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.

Get the local gateway.

Parameters

address

SocketAddress representation of gateway address

Return values

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.

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

Get the local IP address.

Parameters

address

SocketAddress representation of the local IP address

Return values

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.

Get the local IP address.

Parameters

address

SocketAddress representation of the local IP address

Return values

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.

Get the IPv6 link local address.

Parameters

address

SocketAddress representation of the link local IPv6 address

Return values

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.

Get the IPv6 link local address.

Parameters

address

SocketAddress representation of the link local IPv6 address

Return values

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.

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.

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.

Get the local network mask.

Parameters

address

SocketAddress representation of netmask

Return values

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.

Get the local network mask.

Parameters

address

SocketAddress representation of netmask

Return values

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.

Gets the current radio signal strength for active connection.

Returns

Connection strength in dBm (negative value).

Implements WiFiInterface.

Provide access to the underlying stack.

Returns

The underlying network stack

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

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

Returns

number of results on success, negative error code on failure.

Implements DNS.

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

hostname	Hostname to resolve.
hints	Pointer to a SocketAddress with query parameters.
callback	Callback that is called for result.
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.

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

Return values

NSAPI_ERROR_OK	on success
int	Negative error code on failure. See NetworkStack::gethostbyname

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.

This function is used to indicate if the device is connected to the network.

Returns

SCL_SUCCESS if device is connected.

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

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

res	Pointer to allocated array to store discovered APs.
count	Size 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.

Scan for available networks in WiFiAccessPoint format.

This function will block.

Parameters

aps	Pointer to allocated array of WiFiAccessPoint format for discovered AP
count	Size of allocated res array, or 0 to only count available AP

Returns

Number of entries in , or if count was 0 number of available networks, negative on error see nsapi_error

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

Set network interface as default one.

Reimplemented from NetworkInterface.

Set blocking status of interface.

Nonblocking mode is not supported.

Parameters

blocking

True if connect is blocking

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

Definition at line 118 of file SclSTAInterface.h.

Sets the Wi-Fi network channel - NOT SUPPORTED.

This function is not supported and will return NSAPI_ERROR_UNSUPPORTED.

Parameters

channel

Channel on which the connection is to be made (Default: 0).

Returns

Not supported, returns NSAPI_ERROR_UNSUPPORTED.

Implements WiFiInterface.

Definition at line 104 of file SclSTAInterface.h.

Set the Wi-Fi network credentials.

Parameters

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)

Returns

0 on success, negative error code on failure.

Implements WiFiInterface.

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.

Enable or disable DHCP on the network.

Requires that the network is disconnected

Parameters

dhcp	False to disable dhcp (defaults to enabled)

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_UNSUPPORTED	if operation is not supported.

Reimplemented from NetworkInterface.

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

dhcp	True to enable DHCP.

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_UNSUPPORTED	if operation is not supported.

Reimplemented in EMACInterface, and L3IPInterface.

Set the MAC address to the interface.

Set the provided MAC address on the network interface. The address must be unique globally. The address must be set before calling the interface connect() method.

Not all interfaces are supporting MAC address set and an error is not returned for this method call. Verify the changed MAC address by checking packet captures from the used network interface.

6-byte EUI-48 MAC addresses are used for Ethernet while Mesh interface is using 8-byte EUI-64 address.

More information about obtaining MAC address can be found from: https://standards.ieee.org/products-services/regauth/index.html

Parameters

mac_addr	Buffer containing the MAC address in hexadecimal format.
addr_len	Length of provided buffer in bytes (6 or 8)

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if address is not valid
NSAPI_ERROR_BUSY	if address can't be set.

Reimplemented from NetworkInterface.

Set the MAC address to the interface.

Set the provided MAC address on the network interface. The address must be unique globally. The address must be set before calling the interface connect() method.

Not all interfaces are supporting MAC address set and an error is not returned for this method call. Verify the changed MAC address by checking packet captures from the used network interface.

6-byte EUI-48 MAC addresses are used for Ethernet while Mesh interface is using 8-byte EUI-64 address.

More information about obtaining MAC address can be found from: https://standards.ieee.org/products-services/regauth/index.html

Parameters

mac_addr	Buffer containing the MAC address in hexadecimal format.
addr_len	Length of provided buffer in bytes (6 or 8)

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if address is not valid
NSAPI_ERROR_BUSY	if address can't be set.

Reimplemented in InterfaceNanostack, and EMACInterface.

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

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

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_address	SocketAddress object containing the local IP address
netmask	SocketAddress object containing the local network mask
gateway	SocketAddress object containing the local gateway

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this function is unsupported

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

Turns on the Wi-Fi device.

Returns

void

This function is used to set up the Wi-Fi interface.

This function should be used after the wifi_on.

Returns

SCL_SUCCESS if the Wi-Fi interface is set up successfully.

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 110 of file WiFiInterface.h.