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

Create an uninitialized WisunInterface.

Must initialize to initialize the mesh on a phy.

Definition at line 49 of file WisunInterface.h.

Create an initialized WisunInterface.

Definition at line 54 of file WisunInterface.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.

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

Start the interface.

Returns

0 on success, negative error code on failure

Implements NetworkInterface.

Stop the interface.

Returns

0 on success, negative error code on failure

Implements NetworkInterface.

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

Enable Wi-SUN statistics.

After enabling statistics those can be read using the network, physical layer, MAC and FHSS and Wi-SUN statistics read functions.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN on error

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

Get Wi-SUN FHSS broadcast channel function parameters.

Function reads FHSS broadcast channel function parameters from mbed-mesh-api.

Parameters

channel_function	Channel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channel	Used channel when channel function is fixed channel.
dwell_interval	Used dwell interval when channel function is TR51 or DH1.
broadcast_interval	Used broadcast interval.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Get Wi-SUN FHSS channel mask.

Function reads FHSS channel mask from mbed-mesh-api.

Parameters

channel_mask

Values defined in Wi-SUN management API. Channel mask bit field.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Get the connection status.

Returns

The connection status according to ConnectionStatusType

Reimplemented from NetworkInterface.

Get the default Mesh interface.

This is provided as a weak method so applications can override. Default behavior is to get the target's default interface, if any.

Returns

pointer to interface, if any.

Return the default network interface.

Returns the default network interface, as determined by JSON option target.network-default-interface-type or other overrides.

The type of the interface returned can be tested by calling ethInterface(), wifiInterface(), meshInterface(), cellularInterface(), emacInterface() and checking for NULL pointers.

The default behavior is to return the default interface for the interface type specified by target.network-default-interface-type. Targets should set this in their targets.json to guide default selection, and applications may override.

The interface returned should be already configured for use such that its connect() method works with no parameters. For connection types needing configuration, settings should normally be obtained from JSON - the settings for the core types are under the "nsapi" JSON config tree.

The list of possible settings for default interface type is open-ended, as is the number of possible providers. Core providers are:

• ETHERNET: EthernetInterface, using default EMAC and OnboardNetworkStack
• MESH: ThreadInterface or LoWPANNDInterface, using default NanostackRfPhy
• CELLULAR: OnboardModemInterface
• WIFI: None - always provided by a specific class

Specific drivers may be activated by other settings of the default-network-interface-type configuration. This will depend on the target and the driver. For example a board may have its default setting as "AUTO" which causes it to autodetect an Ethernet cable. This should be described in the target's documentation.

An application can override all target settings by implementing NetworkInterface::get_default_instance() themselves - the default definition is weak, and calls get_target_default_instance().

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 CellularContext, EMACInterface, CellularInterface, PPPInterface, and AT_CellularContext.

Get the interface ID.

Returns

Interface identifier

Definition at line 157 of file MeshInterfaceNanostack.h.

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 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 internally stored MAC address /return MAC address of the interface.

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 CellularContext, EMACInterface, CellularInterface, PPPInterface, and AT_CellularContext.

Get Wi-SUN network name.

Function reads network name from mbed-mesh-api.

Parameters

network_name

Network name as NUL terminated string. Must have space for 33 characters (string and null terminator).

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Get Wi-SUN network regulatory domain, operating class and operating mode.

Function reads regulatory_domain, operating_class and operating_mode from mbed-mesh-api.

Parameters

regulatory_domain	Values defined in Wi-SUN PHY-specification.
operating_class	Values defined in Wi-SUN PHY-specification.
operating_mode	Values defined in Wi-SUN PHY-specification.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Get Wi-SUN network size.

Function reads network size from mbed-mesh-api.

Parameters

network_size

Network size in hundreds of devices, 0x00 for network size certificate.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Get Wi-SUN timing parameters.

Function reads timing parameters from mbed-mesh-api.

Parameters

disc_trickle_imin	Discovery trickle Imin. Range 1-255 seconds.
disc_trickle_imax	Discovery trickle Imax. Range (2-2^8)*Imin.
disc_trickle_k	Discovery trickle k.
pan_timeout	PAN timeout; seconds; Range 60-15300 seconds.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Get Wi-SUN FHSS unicast channel function parameters.

Function reads FHSS unicast channel function parameters from mbed-mesh-api.

Parameters

channel_function	Channel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channel	Used channel when channel function is fixed channel.
dwell_interval	Used dwell interval when channel function is TR51 or DH1.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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.

Get router IP address.

Parameters

address
len

Get Wi-SUN Router information.

Function reads RPL information from nanostack. Mesh interface must be initialized before calling this function.

Parameters

info_ptr

Structure given to stack where information will be stored

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Attach phy and initialize the mesh.

Initializes a mesh interface on the given phy. Not needed if the phy is passed to the mesh's constructor.

Returns

0 on success, negative on failure

Return pointer to a MeshInterface.

Returns

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

Reimplemented from NetworkInterface.

Definition at line 33 of file MeshInterface.h.

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

Reads Wi-SUN MAC statistics.

Reads MAC statistics.

Parameters

statistics

MAC statistics.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN on error

Reads Wi-SUN network statistics.

Reads network statistics.

Parameters

statistics

Network statistics.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN on error

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters

status_cb

The callback to unregister.

Remove own certificates from the Wi-SUN network.

Function must be called before connecting the device i.e before call to connect() method.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_STATE if method is called after calling connect().

Remove trusted certificates from the Wi-SUN network.

Function must be called before connecting the device i.e before call to connect() method.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_STATE if method is called after calling connect().

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

Set blocking status of connect() which by default should be blocking.

Parameters

blocking

true if connect is blocking

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

Set Wi-SUN FHSS broadcast channel function parameters.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the channel function, fixed channel, dwell interval or broadcast_interval.

Function overwrites parameters defined by Mbed OS configuration.

Parameters

channel_function	Channel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channel	Used channel when channel function is fixed channel. Use 0xffff when fixed channel function not on use.
dwell_interval	Used dwell interval when channel function is TR51 or DH1. Use 0x00 to use leave parameter unchanged.
broadcast_interval	Used broadcast interval. Use 0x00 to use leave parameter unchanged.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Set Wi-SUN FHSS channel mask.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then settings take effect right away.

Parameters

channel_mask

Values defined in Wi-SUN management API. Channel mask bit field.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in EMACInterface, and L3IPInterface.

Set file system root path.

Set file system root path that stack will use to write and read its data. Setting root_path to NULL will disable file system usage.

Parameters

root_path

Address to NUL-terminated root-path string or NULL to disable file system usage.

Returns

MESH_ERROR_NONE on success, MESH_ERROR_MEMORY in case of memory failure, MESH_ERROR_UNKNOWN in case of other error.

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

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface.

Set Wi-SUN network name.

Function stores new network name to mbed-mesh-api and uses it when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the network name.

Function overwrites network name defined by Mbed OS configuration.

Parameters

network_name

Network name as NUL terminated string. Can't exceed 32 characters and can't be NULL.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Set Wi-SUN network regulatory domain, operating class and operating mode.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the regulatory_domain, operating_class or operating_mode.

Function overwrites parameters defined by Mbed OS configuration.

Parameters

regulatory_domain	Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
operating_class	Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
operating_mode	Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Set Wi-SUN network size.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the network size.

Default value: medium Small network size: less than hundred devices Medium network size: hundreds of devices Large network size: thousands of devices Certificate: used on testing

When network size is changed, it will override all or some of the following configuration values:

• Timing settings set by set_timing_parameters() of the Wi-SUN interface.
• RPL settings set by rpl_parameters_set() of the Border Router interface.

When network size is changed, and if timing or RPL values should be other than defaults set by stack for the network size, they need to set again using above function calls.

Parameters

network_size

Network size in hundreds of devices (e.g. 1200 devices is 12), 0x00 for network size certificate.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Set own certificate and private key reference to the Wi-SUN network.

Function can be called several times if intermediate certificates are used. Then each call to the function adds a certificate reference to own certificate chain. Certificates are in bottom up order i.e. the top certificate is given last.

Function must be called before connecting the device i.e before call to connect() method. Function will not copy certificate or key, therefore addresses must remain valid.

Parameters

cert	Certificate address.
cert_len	Certificate length in bytes.
cert_key	Certificate key address.
cert_key_len	Certificate key length in bytes.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_STATE if method is called after calling connect().

MESH_ERROR_MEMORY in case of memory allocation failure.

Set Wi-SUN timing parameters.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then settings take effect right away.

Parameters

disc_trickle_imin	Discovery trickle Imin. Range 1-255 seconds. Use 0x00 to use leave parameter unchanged.
disc_trickle_imax	Discovery trickle Imax. Range (2-2^8)*Imin. Use 0x00 to use leave parameter unchanged.
disc_trickle_k	Discovery trickle k. Use 0x00 to use leave parameter unchanged.
pan_timeout	PAN timeout; seconds; Range 60-15300 seconds. Use 0x00 to use leave parameter unchanged.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Set trusted certificate reference to the Wi-SUN network.

Function can be called several times. Certificates are in bottom up order i.e. the top certificate is given last.

Function must be called before connecting the device i.e before call to connect() method. Function will not copy certificate, therefore addresses must remain valid.

Parameters

cert	Certificate address.
cert_len	Certificate length in bytes.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_STATE if method is called after calling connect().

MESH_ERROR_MEMORY in case of memory allocation failure.

Set Wi-SUN FHSS unicast channel function parameters.

Function stores new parameters to mbed-mesh-api and uses them when connect() is called next time. If device is already connected to the Wi-SUN network then device will restart network discovery after changing the channel function, fixed channel or dwell interval.

Function overwrites parameters defined by Mbed OS configuration.

Parameters

channel_function	Channel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channel	Used channel when channel function is fixed channel. Use 0xffff when fixed channel function not on use.
dwell_interval	Used dwell interval when channel function is TR51 or DH1. Use 0x00 to use leave parameter unchanged.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validate Wi-SUN FHSS broadcast channel function parameters.

Function validates FHSS broadcast channel function parameters from mbed-mesh-api. Function can be used to test that values that will be used on set function are valid.

Parameters

channel_function	Channel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channel	Used channel when channel function is fixed channel.
dwell_interval	Used dwell interval when channel function is TR51 or DH1.
broadcast_interval	Used broadcast interval.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validate Wi-SUN FHSS channel mask.

Function validates FHSS channel mask. Function can be used to test that values that will be used on set function are valid.

Parameters

channel_mask

Values defined in Wi-SUN management API. Channel mask bit field.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validate Wi-SUN network name.

Function validates network name. Function can be used to test that values that will be used on set function are valid.

Parameters

network_name

Network name as NUL terminated string. Can't exceed 32 characters and can't be NULL.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validate Wi-SUN network regulatory domain, operating class and operating mode.

Function validates regulatory_domain, operating_class and operating_mode. Function can be used to test that values that will be used on set function are valid.

Parameters

regulatory_domain	Values defined in Wi-SUN PHY-specification.
operating_class	Values defined in Wi-SUN PHY-specification.
operating_mode	Values defined in Wi-SUN PHY-specification.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validate Wi-SUN network size.

Function validates network size from mbed-mesh-api. Function can be used to test that values that will be used on set function are valid.

Parameters

network_size

Network size in hundreds of devices, 0x00 for network size certificate.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validates Wi-SUN timing parameters.

Function validates timing parameters. Function can be used to test that values that will be used on set function are valid.

Parameters

disc_trickle_imin	Discovery trickle Imin. Range 1-255 seconds.
disc_trickle_imax	Discovery trickle Imax. Range (2-2^8)*Imin.
disc_trickle_k	Discovery trickle k.
pan_timeout	PAN timeout; seconds; Range 60-15300 seconds.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

Validate Wi-SUN FHSS unicast channel function parameters.

Function validates FHSS unicast channel function parameters. Function can be used to test that values that will be used on set function are valid.

Parameters

channel_function	Channel function. Fixed, TR51CF, DH1CF or vendor defined.
fixed_channel	Used channel when channel function is fixed channel.
dwell_interval	Used dwell interval when channel function is TR51 or DH1.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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