Wi-SUN mesh network interface class. More...

#include <WisunInterface.h>

Inheritance diagram for WisunInterface:

Public Types
typedef mbed::Callback< void(nsapi_value_or_error_t result, SocketAddress *address)>	hostbyname_cb_t
	Hostname translation callback (for use with gethostbyname_async()). More...

Public Member Functions
mesh_error_t	set_network_name (char *network_name)
	Set Wi-SUN network name. More...

mesh_error_t	get_network_name (char *network_name)
	Get Wi-SUN network name. More...

mesh_error_t	validate_network_name (char *network_name)
	Validate Wi-SUN network name. More...

mesh_error_t	set_network_regulatory_domain (uint8_t regulatory_domain=0xff, uint8_t operating_class=0xff, uint8_t operating_mode=0xff)
	Set Wi-SUN network regulatory domain, operating class and operating mode. More...

mesh_error_t	get_network_regulatory_domain (uint8_t regulatory_domain, uint8_t operating_class, uint8_t *operating_mode)
	Get Wi-SUN network regulatory domain, operating class and operating mode. More...

mesh_error_t	validate_network_regulatory_domain (uint8_t regulatory_domain, uint8_t operating_class, uint8_t operating_mode)
	Validate Wi-SUN network regulatory domain, operating class and operating mode. More...

mesh_error_t	set_network_domain_configuration (uint8_t regulatory_domain, uint8_t phy_mode_id, uint8_t channel_plan_id)
	Set Wi-SUN network regulatory domain, PHY mode ID and channel plan ID. More...

mesh_error_t	get_network_domain_configuration (uint8_t regulatory_domain, uint8_t phy_mode_id, uint8_t *channel_plan_id)
	Get Wi-SUN network regulatory domain, PHY mode ID and channel plan ID. More...

mesh_error_t	validate_network_domain_configuration (uint8_t regulatory_domain, uint8_t phy_mode_id, uint8_t channel_plan_id)
	Validate Wi-SUN network regulatory domain, PHY mode ID and channel plan ID. More...

mesh_error_t	set_network_size (uint8_t network_size)
	Set Wi-SUN network size. More...

mesh_error_t	get_network_size (uint8_t *network_size)
	Get Wi-SUN network size. More...

mesh_error_t	validate_network_size (uint8_t network_size)
	Validate Wi-SUN network size. More...

mesh_error_t	set_channel_mask (uint32_t channel_mask[8])
	Set Wi-SUN FHSS channel mask. More...

mesh_error_t	get_channel_mask (uint32_t *channel_mask)
	Get Wi-SUN FHSS channel mask. More...

mesh_error_t	validate_channel_mask (uint32_t channel_mask[8])
	Validate Wi-SUN FHSS channel mask. More...

mesh_error_t	set_unicast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel=0xffff, uint8_t dwell_interval=0x00)
	Set Wi-SUN FHSS unicast channel function parameters. More...

mesh_error_t	get_unicast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel, uint8_t *dwell_interval)
	Get Wi-SUN FHSS unicast channel function parameters. More...

mesh_error_t	validate_unicast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel, uint8_t dwell_interval)
	Validate Wi-SUN FHSS unicast channel function parameters. More...

mesh_error_t	set_broadcast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel=0xffff, uint8_t dwell_interval=0x00, uint32_t broadcast_interval=0x00)
	Set Wi-SUN FHSS broadcast channel function parameters. More...

mesh_error_t	get_broadcast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel, uint8_t dwell_interval, uint32_t broadcast_interval)
	Get Wi-SUN FHSS broadcast channel function parameters. More...

mesh_error_t	validate_broadcast_channel_function (mesh_channel_function_t channel_function, uint16_t fixed_channel, uint8_t dwell_interval, uint32_t broadcast_interval)
	Validate Wi-SUN FHSS broadcast channel function parameters. More...

mesh_error_t	set_timing_parameters (uint16_t disc_trickle_imin=0x00, uint16_t disc_trickle_imax=0x00, uint8_t disc_trickle_k=0x00, uint16_t pan_timeout=0x00)
	Set Wi-SUN timing parameters. More...

mesh_error_t	get_timing_parameters (uint16_t disc_trickle_imin, uint16_t disc_trickle_imax, uint8_t disc_trickle_k, uint16_t pan_timeout)
	Get Wi-SUN timing parameters. More...

mesh_error_t	validate_timing_parameters (uint16_t disc_trickle_imin, uint16_t disc_trickle_imax, uint8_t disc_trickle_k, uint16_t pan_timeout)
	Validates Wi-SUN timing parameters. More...

mesh_error_t	set_device_min_sens (uint8_t device_min_sens)
	Set Wi-SUN device minimum sensitivity. More...

mesh_error_t	get_device_min_sens (uint8_t *device_min_sens)
	Get Wi-SUN device minimum sensitivity. More...

mesh_error_t	validate_device_min_sens (uint8_t device_min_sens)
	Validates Device minimum sensitivity. More...

mesh_error_t	set_own_certificate (uint8_t cert, uint16_t cert_len, uint8_t cert_key=NULL, uint16_t cert_key_len=0)
	Set own certificate and private key reference to the Wi-SUN network. More...

mesh_error_t	remove_own_certificates (void)
	Remove own certificates from the Wi-SUN network. More...

mesh_error_t	set_trusted_certificate (uint8_t *cert, uint16_t cert_len)
	Set trusted certificate reference to the Wi-SUN network. More...

mesh_error_t	remove_trusted_certificates (void)
	Remove trusted certificates from the Wi-SUN network. More...

bool	getRouterIpAddress (char *address, int8_t len)
	Get router IP address. More...

mesh_error_t	enable_statistics (void)
	Enable Wi-SUN statistics. More...

mesh_error_t	reset_statistics (void)
	Reset Wi-SUN statistics. More...

mesh_error_t	read_nw_statistics (mesh_nw_statistics_t *statistics)
	Reads Wi-SUN network statistics. More...

mesh_error_t	read_mac_statistics (mesh_mac_statistics_t *statistics)
	Reads Wi-SUN MAC statistics. More...

mesh_error_t	info_get (ws_rpl_info_t *info_ptr)
	Get Wi-SUN Router information. More...

mesh_error_t	stack_info_get (ws_stack_state_t *stack_info_ptr)
	Get Wi-SUN Stack information. More...

mesh_error_t	cca_threshold_table_get (ws_cca_threshold_table_t *table)
	Get Wi-SUN CCA threshold table information. More...

mesh_error_t	nbr_info_get (ws_nbr_info_t nbr_ptr, uint16_t count)
	Get Wi-SUN Neighbor table information. More...

	MeshInterfaceNanostack ()=default
	Inherit MeshInterfaceNanostack constructors. More...

	MeshInterfaceNanostack (NanostackRfPhy *phy)
	Inherit MeshInterfaceNanostack constructors. More...

nsapi_error_t	initialize (NanostackRfPhy *phy)
	Attach phy and initialize the mesh. More...

nsapi_error_t	connect () override
	Start the interface. More...

nsapi_error_t	disconnect () override
	Stop the interface. More...

nsapi_error_t	get_ip_address (SocketAddress *address) override
	Get the local IP address. More...

const char *	get_mac_address () override
	Get the internally stored MAC address /return MAC address of the interface. More...

nsapi_error_t	set_mac_address (uint8_t *mac_addr, nsapi_size_t addr_len) override
	Set the MAC address to the interface. More...

void	attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) override
	Register callback for status reporting. More...

nsapi_connection_status_t	get_connection_status () const override
	Get the connection status. More...

nsapi_error_t	set_blocking (bool blocking) override
	Set blocking status of connect() which by default should be blocking. More...

nsapi_error_t	set_file_system_root_path (const char *root_path)
	Set file system root path. More...

int8_t	get_interface_id () const
	Get the interface ID. More...

virtual void	set_as_default ()
	Set network interface as default one. More...

virtual const char *	get_hostname ()
	Get hostname. More...

virtual nsapi_error_t	set_hostname (const char *hostname)
	Set hostname. More...

virtual nsapi_error_t	get_ipv6_link_local_address (SocketAddress *address)
	Get the IPv6 link local address. More...

virtual nsapi_error_t	get_netmask (SocketAddress *address)
	Get the local network mask. More...

virtual nsapi_error_t	get_gateway (SocketAddress *address)
	Get the local gateway. More...

virtual char *	get_interface_name (char *interface_name)
	Get the network interface name. More...

virtual nsapi_error_t	set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &gateway)
	Configure this network interface to use a static IP address. More...

virtual nsapi_error_t	set_dhcp (bool dhcp)
	Enable or disable DHCP on connecting the network. 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	getaddrinfo (const char hostname, SocketAddress hints, SocketAddress *res, const char interface_name=NULL)
	Translate a hostname to the multiple IP addresses 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_value_or_error_t	getaddrinfo_async (const char hostname, SocketAddress hints, hostbyname_cb_t callback, const char *interface_name=NULL)
	Translate a hostname to the multiple IP addresses (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...

virtual nsapi_error_t	get_dns_server (int index, SocketAddress address, const char interface_name=NULL)
	Get a domain name server from a 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...

virtual EthInterface *	ethInterface ()
	Return pointer to an EthInterface. More...

virtual WiFiInterface *	wifiInterface ()
	Return pointer to a WiFiInterface. More...

virtual MeshInterface *	meshInterface ()
	Return pointer to a MeshInterface. More...

MeshInterface *	meshInterface () final
	Return pointer to a MeshInterface. More...

virtual EMACInterface *	emacInterface ()
	Return pointer to an EMACInterface. More...

virtual CellularInterface *	cellularInterface ()
	Return pointer to a CellularInterface. More...

virtual void	set_default_parameters ()
	defined(DOXYGEN_ONLY) More...

Static Public Member Functions
static NetworkInterface *	get_default_instance ()
	Return the default network interface. More...

static MeshInterface *	get_default_instance ()
	Get the default Mesh interface. More...

Detailed Description

Wi-SUN mesh network interface class.

Configure Nanostack to use Wi-SUN protocol.

Definition at line 105 of file WisunInterface.h.

Member Typedef Documentation

◆ hostbyname_cb_t

typedef mbed::Callback<void (nsapi_value_or_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.

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

Member Function Documentation

◆ set_network_name()

mesh_error_t set_network_name ( char * network_name )

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.

◆ get_network_name()

mesh_error_t get_network_name ( char * network_name )

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.

◆ validate_network_name()

mesh_error_t validate_network_name ( char * network_name )

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.

◆ set_network_regulatory_domain()

mesh_error_t set_network_regulatory_domain	(	uint8_t	regulatory_domain = `0xff`,
		uint8_t	operating_class = `0xff`,
		uint8_t	operating_mode = `0xff`
	)

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.

◆ get_network_regulatory_domain()

mesh_error_t get_network_regulatory_domain	(	uint8_t *	regulatory_domain,
		uint8_t *	operating_class,
		uint8_t *	operating_mode
	)

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.

◆ validate_network_regulatory_domain()

mesh_error_t validate_network_regulatory_domain	(	uint8_t	regulatory_domain,
		uint8_t	operating_class,
		uint8_t	operating_mode
	)

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.

◆ set_network_domain_configuration()

mesh_error_t set_network_domain_configuration	(	uint8_t	regulatory_domain,
		uint8_t	phy_mode_id,
		uint8_t	channel_plan_id
	)

Set Wi-SUN network regulatory domain, PHY mode ID and channel plan ID.

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, phy_mode_id or channel_plan_id.

Parameters

regulatory_domain	Values defined in Wi-SUN PHY-specification. Use 0 to leave parameter unchanged or 0xff to use default value.
phy_mode_id	Values defined in Wi-SUN PHY-specification. Use 0 to leave parameter unchanged or 0xff to use default value.
channel_plan_id	Values defined in Wi-SUN PHY-specification. Use 0 to leave parameter unchanged or 0xff to use default value.

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN in case of failure.

◆ get_network_domain_configuration()

mesh_error_t get_network_domain_configuration	(	uint8_t *	regulatory_domain,
		uint8_t *	phy_mode_id,
		uint8_t *	channel_plan_id
	)

Get Wi-SUN network regulatory domain, PHY mode ID and channel plan ID.

Function reads regulatory_domain, phy_mode_id and channel_plan_id from mbed-mesh-api.

Parameters

regulatory_domain	Values defined in Wi-SUN PHY-specification.
phy_mode_id	Values defined in Wi-SUN PHY-specification.
channel_plan_id	Values defined in Wi-SUN PHY-specification.

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN in case of failure.

◆ validate_network_domain_configuration()

mesh_error_t validate_network_domain_configuration	(	uint8_t	regulatory_domain,
		uint8_t	phy_mode_id,
		uint8_t	channel_plan_id
	)

Validate Wi-SUN network regulatory domain, PHY mode ID and channel plan ID.

Function validates regulatory_domain, phy_mode_id and channel_plan_id. 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.
phy_mode_id	Values defined in Wi-SUN PHY-specification.
channel_plan_id	Values defined in Wi-SUN PHY-specification.

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN in case of failure.

◆ set_network_size()

mesh_error_t set_network_size ( uint8_t network_size )

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.

◆ get_network_size()

mesh_error_t get_network_size ( uint8_t * network_size )

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.

◆ validate_network_size()

mesh_error_t validate_network_size ( uint8_t network_size )

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.

◆ set_channel_mask()

mesh_error_t set_channel_mask ( uint32_t channel_mask[8] )

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.

◆ get_channel_mask()

mesh_error_t get_channel_mask ( uint32_t * channel_mask )

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.

◆ validate_channel_mask()

mesh_error_t validate_channel_mask ( uint32_t channel_mask[8] )

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.

◆ set_unicast_channel_function()

mesh_error_t set_unicast_channel_function	(	mesh_channel_function_t	channel_function,
		uint16_t	fixed_channel = `0xffff`,
		uint8_t	dwell_interval = `0x00`
	)

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

mesh_error_t get_unicast_channel_function	(	mesh_channel_function_t *	channel_function,
		uint16_t *	fixed_channel,
		uint8_t *	dwell_interval
	)

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.

◆ validate_unicast_channel_function()

mesh_error_t validate_unicast_channel_function	(	mesh_channel_function_t	channel_function,
		uint16_t	fixed_channel,
		uint8_t	dwell_interval
	)

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.

◆ set_broadcast_channel_function()

mesh_error_t set_broadcast_channel_function	(	mesh_channel_function_t	channel_function,
		uint16_t	fixed_channel = `0xffff`,
		uint8_t	dwell_interval = `0x00`,
		uint32_t	broadcast_interval = `0x00`
	)

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.

◆ get_broadcast_channel_function()

mesh_error_t get_broadcast_channel_function	(	mesh_channel_function_t *	channel_function,
		uint16_t *	fixed_channel,
		uint8_t *	dwell_interval,
		uint32_t *	broadcast_interval
	)

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.

◆ validate_broadcast_channel_function()

mesh_error_t validate_broadcast_channel_function	(	mesh_channel_function_t	channel_function,
		uint16_t	fixed_channel,
		uint8_t	dwell_interval,
		uint32_t	broadcast_interval
	)

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.

◆ set_timing_parameters()

mesh_error_t set_timing_parameters	(	uint16_t	disc_trickle_imin = `0x00`,
		uint16_t	disc_trickle_imax = `0x00`,
		uint8_t	disc_trickle_k = `0x00`,
		uint16_t	pan_timeout = `0x00`
	)

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.

◆ get_timing_parameters()

mesh_error_t get_timing_parameters	(	uint16_t *	disc_trickle_imin,
		uint16_t *	disc_trickle_imax,
		uint8_t *	disc_trickle_k,
		uint16_t *	pan_timeout
	)

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.

◆ validate_timing_parameters()

mesh_error_t validate_timing_parameters	(	uint16_t	disc_trickle_imin,
		uint16_t	disc_trickle_imax,
		uint8_t	disc_trickle_k,
		uint16_t	pan_timeout
	)

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.

◆ set_device_min_sens()

mesh_error_t set_device_min_sens ( uint8_t device_min_sens )

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.

◆ get_device_min_sens()

mesh_error_t get_device_min_sens ( uint8_t * device_min_sens )

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.

◆ validate_device_min_sens()

mesh_error_t validate_device_min_sens ( uint8_t device_min_sens )

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.

◆ set_own_certificate()

mesh_error_t set_own_certificate	(	uint8_t *	cert,
		uint16_t	cert_len,
		uint8_t *	cert_key = `NULL`,
		uint16_t	cert_key_len = `0`
	)

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.

◆ remove_own_certificates()

mesh_error_t remove_own_certificates ( void )

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

◆ set_trusted_certificate()

mesh_error_t set_trusted_certificate	(	uint8_t *	cert,
		uint16_t	cert_len
	)

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.

◆ remove_trusted_certificates()

mesh_error_t remove_trusted_certificates ( void )

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

◆ getRouterIpAddress()

bool getRouterIpAddress	(	char *	address,
		int8_t	len
	)

Get router IP address.

Parameters

address
len

◆ enable_statistics()

mesh_error_t enable_statistics ( void )

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

◆ reset_statistics()

mesh_error_t reset_statistics ( void )

Reset Wi-SUN statistics.

Resets MAC statistics and Wi-SUN statistics.

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN on error

◆ read_nw_statistics()

mesh_error_t read_nw_statistics ( mesh_nw_statistics_t * statistics )

Reads Wi-SUN network statistics.

Reads network statistics.

Parameters

statistics Network statistics.

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN on error

◆ read_mac_statistics()

mesh_error_t read_mac_statistics ( mesh_mac_statistics_t * statistics )

Reads Wi-SUN MAC statistics.

Reads MAC statistics.

Parameters

statistics MAC statistics.

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN on error

◆ info_get()

mesh_error_t info_get ( ws_rpl_info_t * info_ptr )

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.

◆ stack_info_get()

mesh_error_t stack_info_get ( ws_stack_state_t * stack_info_ptr )

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.

◆ cca_threshold_table_get()

mesh_error_t cca_threshold_table_get ( ws_cca_threshold_table_t * table )

Get Wi-SUN CCA threshold table information.

Function reads CCA threshold table from nanostack.

Parameters

table Structure given to stack where information will be stored

Returns: MESH_ERROR_NONE on success.; MESH_ERROR_UNKNOWN in case of failure.

◆ nbr_info_get()

mesh_error_t nbr_info_get	(	ws_nbr_info_t *	nbr_ptr,
		uint16_t *	count
	)

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.

◆ MeshInterfaceNanostack() [1/2]

MeshInterfaceNanostack ( )

default

Inherit MeshInterfaceNanostack constructors.

◆ MeshInterfaceNanostack() [2/2]

MeshInterfaceNanostack ( NanostackRfPhy * phy )

Inherit MeshInterfaceNanostack constructors.

Definition at line 182 of file MeshInterfaceNanostack.h.

◆ initialize()

nsapi_error_t initialize ( NanostackRfPhy * phy )

inherited

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

◆ connect()

nsapi_error_t connect ( )

overridevirtualinherited

Start the interface.

Returns: 0 on success, negative error code on failure

Implements NetworkInterface.

◆ disconnect()

nsapi_error_t disconnect ( )

overridevirtualinherited

Stop the interface.

Returns: 0 on success, negative error code on failure

Implements NetworkInterface.

◆ get_ip_address()

nsapi_error_t get_ip_address ( SocketAddress * address )

overridevirtualinherited

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

const char * get_mac_address ( )

overridevirtualinherited

Get the internally stored MAC address /return MAC address of the interface.

Reimplemented from NetworkInterface.

◆ set_mac_address()

nsapi_error_t set_mac_address	(	uint8_t *	mac_addr,
		nsapi_size_t	addr_len
	)

overridevirtualinherited

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.

◆ attach()

void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb )

overridevirtualinherited

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

nsapi_connection_status_t get_connection_status ( ) const

overridevirtualinherited

Get the connection status.

Returns: The connection status according to ConnectionStatusType

Reimplemented from NetworkInterface.

◆ set_blocking()

nsapi_error_t set_blocking ( bool blocking )

overridevirtualinherited

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

nsapi_error_t set_file_system_root_path ( const char * root_path )

inherited

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.

◆ get_interface_id()

int8_t get_interface_id ( ) const

inherited

Get the interface ID.

Returns: Interface identifier

Definition at line 145 of file MeshInterfaceNanostack.h.

◆ get_default_instance() [1/2]

static NetworkInterface * get_default_instance ( )

staticinherited

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_default_instance() [2/2]

static MeshInterface * get_default_instance ( )

staticinherited

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.

◆ set_as_default()

virtual void set_as_default ( )

virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

◆ get_hostname()

virtual const char * get_hostname ( )

virtualinherited

Get hostname.

Returns: Hostname if configured, null otherwise

Reimplemented in EMACInterface.

◆ set_hostname()

virtual nsapi_error_t set_hostname ( const char * hostname )

virtualinherited

Set hostname.

Parameters

hostname Hostname string

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if hostname is not valid
NSAPI_ERROR_BUSY	if hostname couldn't be set (e.g. for LwIP stack, hostname can only be set before calling `EthernetInterface::connect` method)

Reimplemented in EMACInterface.

◆ get_ipv6_link_local_address()

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress * address )

virtualinherited

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

virtual nsapi_error_t get_netmask ( SocketAddress * address )

virtualinherited

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

virtual nsapi_error_t get_gateway ( SocketAddress * address )

virtualinherited

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, and PPPInterface.

◆ get_interface_name()

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 in AT_CellularContext, EMACInterface, L3IPInterface, and PPPInterface.

◆ set_network()

virtual nsapi_error_t set_network	(	const SocketAddress &	ip_address,
		const SocketAddress &	netmask,
		const SocketAddress &	gateway
	)

virtualinherited

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

virtual nsapi_error_t set_dhcp ( bool dhcp )

virtualinherited

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.

◆ gethostbyname()

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

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.

◆ getaddrinfo()

virtual nsapi_value_or_error_t getaddrinfo	(	const char *	hostname,
		SocketAddress *	hints,
		SocketAddress **	res,
		const char *	interface_name = `NULL`
	)

virtualinherited

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.

◆ gethostbyname_async()

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

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.

◆ getaddrinfo_async()

virtual nsapi_value_or_error_t getaddrinfo_async	(	const char *	hostname,
		SocketAddress *	hints,
		hostbyname_cb_t	callback,
		const char *	interface_name = `NULL`
	)

virtualinherited

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.

◆ gethostbyname_async_cancel()

virtual nsapi_error_t gethostbyname_async_cancel ( int id )

virtualinherited

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.

◆ add_dns_server()

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

address	Address for the dns host.
interface_name	Network interface name. Currently unused, the server is added for all interfaces.

Returns: NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

◆ get_dns_server()

virtual nsapi_error_t get_dns_server	(	int	index,
		SocketAddress *	address,
		const char *	interface_name = `NULL`
	)

virtualinherited

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

◆ add_event_listener()

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.

Warning: This version of the function does not use the std::nothrow feature. Subsequently, the function may fail to allocate memory and cause a system error. To use the new version with the changes, set "nsapi.add-event-listener-return-change": 1 in the target overrides section in your mbed_app.json file.

Parameters

status_cb The callback for status changes.

◆ ethInterface()

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

◆ wifiInterface()

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

◆ meshInterface() [1/2]

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

◆ meshInterface() [2/2]

MeshInterface * meshInterface ( )

finalvirtualinherited

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.

◆ emacInterface()

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

Definition at line 487 of file NetworkInterface.h.

◆ cellularInterface()

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

◆ set_default_parameters()

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.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ hostbyname_cb_t

Member Function Documentation

◆ set_network_name()

◆ get_network_name()

◆ validate_network_name()

◆ set_network_regulatory_domain()

◆ get_network_regulatory_domain()

◆ validate_network_regulatory_domain()

◆ set_network_domain_configuration()

◆ get_network_domain_configuration()

◆ validate_network_domain_configuration()

◆ set_network_size()

◆ get_network_size()

◆ validate_network_size()

◆ set_channel_mask()

◆ get_channel_mask()

◆ validate_channel_mask()

◆ set_unicast_channel_function()

◆ get_unicast_channel_function()

◆ validate_unicast_channel_function()

◆ set_broadcast_channel_function()

◆ get_broadcast_channel_function()

◆ validate_broadcast_channel_function()

◆ set_timing_parameters()

◆ get_timing_parameters()

◆ validate_timing_parameters()

◆ set_device_min_sens()

◆ get_device_min_sens()

◆ validate_device_min_sens()

◆ set_own_certificate()

◆ remove_own_certificates()

◆ set_trusted_certificate()

◆ remove_trusted_certificates()

◆ getRouterIpAddress()

◆ enable_statistics()

◆ reset_statistics()

◆ read_nw_statistics()

◆ read_mac_statistics()

◆ info_get()

◆ stack_info_get()

◆ cca_threshold_table_get()

◆ nbr_info_get()

◆ MeshInterfaceNanostack() [1/2]

◆ MeshInterfaceNanostack() [2/2]

◆ initialize()

◆ connect()

◆ disconnect()

◆ get_ip_address()

◆ get_mac_address()

◆ set_mac_address()

◆ attach()

◆ get_connection_status()

◆ set_blocking()

◆ set_file_system_root_path()

◆ get_interface_id()

◆ get_default_instance() [1/2]

◆ get_default_instance() [2/2]

◆ set_as_default()

◆ get_hostname()

◆ set_hostname()

◆ get_ipv6_link_local_address()

◆ get_netmask()

◆ get_gateway()

◆ get_interface_name()

◆ set_network()

◆ set_dhcp()

◆ gethostbyname()

◆ getaddrinfo()

◆ gethostbyname_async()

◆ getaddrinfo_async()

◆ gethostbyname_async_cancel()

◆ add_dns_server()

◆ get_dns_server()

◆ add_event_listener()

◆ ethInterface()