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.

Parameters

status_cb

The callback for status changes

Reimplemented from NetworkInterface.

Get Wi-SUN CCA threshold table information.

Function reads CCA threshold table from nanostack.

Parameters

ws_cca_threshold_table_t

Structure given to stack where information will be stored

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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.

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 448 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 424 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 Wi-SUN device minimum sensitivity.

Function reads device minimum sensitivity from mbed-mesh-api.

Parameters

device_min_sens

Device minimum sensitivity. Range 0-254.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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

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

Returns

Interface identifier

Definition at line 145 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 EMACInterface, L3IPInterface, and PPPInterface.

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

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

Get Wi-SUN Neighbor table information.

To allocate correct amount of memory first use the API with nbr_ptr = NULL to get current amount of neighbors in count pointer. Then Allocate the memory and call the function to fill the table.

Parameters

nbr_ptr	Pointer to memory where Neighbor table entries can be written.
count	amount of neighbor table entries allocated to memory.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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

Reset Wi-SUN statistics.

Resets MAC statistics and Wi-SUN statistics.

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN on error

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

Set Wi-SUN device minimum sensitivity.

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

device_min_sens

Device minimum sensitivity. Range 0(-174 dB) to 254(+80 dB).

Returns

MESH_ERROR_NONE on success.

MESH_ERROR_UNKNOWN in case of failure.

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

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.

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.

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 network size parameter to the mbed-mesh-api and uses it when connect() is called for the next time. If a device is already connected to the Wi-SUN network, then the device will restart network discovery after changing the network size.

It is recommended to set the correct network size because some Wi-SUN network configuration parameters are adjusted based on the selected network size. A network configured for a small amount of devices may not work optimally for large number of devices. This is because the network bandwidth is divided with all the devices in the network. Enough bandwidth must be reserved for application data usage as well as the Wi-SUN network operations. In addition, the application should adapt to the network characteristics by using the InternetSocket methods get_stagger_estimate_to_address() and get_rtt_estimate_to_address().

The network size is measured as hundreds of devices that are expected to join to the network. For example, for a 400-device network set network size to 4.

The Wi-SUN stack will automatically adjust timing and RPL configuration values based on the selected network size and data rate. If a customized timing or RPL values are needed, the APIs below should be invoked after changing the network size:

• set_timing_parameters() to set timing settings to the Wi-SUN interface.
• rpl_parameters_set() to set RPL settings to the Border Router interface.

By default the Wi-SUN stack is configured to use a few hundreds of devices.

The network size should be set to 0 when running certification tests.

Parameters

network_size

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

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. own certificate is given first and the top certificate is given last.

PEM formatted certificates must use either "\n" or "\r\n" as line separator. PEM formatted certificates must be NUL terminated and the NUL terminator is counted to certificate length.

It is possible to add multiple PEM certificates concatenated together in one call set_own_certificate(). In that case certificates are in bottom up order i.e. own certificate is given first and the top certificate is given last. NUL terminator is added after the last concatenated certificate and the NUL terminator is counted to total concatenated certificate length.

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. Each call to the function adds a trusted certificate to Wi-SUN.

PEM formatted certificates must use either "\n" or "\r\n" as line separator. PEM formatted certificates must be NUL terminated and the NUL terminator is counted to certificate length.

It is possible to add multiple PEM certificates concatenated together in one call set_trusted_certificate(). NUL terminator is added after the last concatenated certificate and the NUL terminator is counted to total concatenated certificate length.

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.

Get Wi-SUN Stack information.

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

Parameters

stack_info_ptr

Structure given to stack where information will be stored

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.

Validates Device minimum sensitivity.

Function validates device minimum sensitivity. Function can be used to test that values that will be used on set function are valid.

Parameters

device_min_sens

Device minimum sensitivity. Range 0-254.

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