Thread mesh network interface class. More...

#include <ThreadInterface.h>

Inherits MeshInterfaceNanostack.

Public Types
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)	hostbyname_cb_t )
	Hostname translation callback (asynchronous)
Public Member Functions
	ThreadInterface ()
	Create an uninitialized ThreadInterface.
	ThreadInterface (NanostackRfPhy *phy)
	Create an initialized ThreadInterface.
void	device_eui64_set (const uint8_t *eui64)
	Sets the eui64 for the device configuration.
void	device_eui64_get (uint8_t *eui64)
	Reads the eui64 from the device configuration.
mesh_error_t	device_pskd_set (const char *pskd)
	sets the PSKd for the device configuration.
nsapi_error_t	initialize (NanostackRfPhy *phy)
	Attach phy and initialize the mesh.
virtual const char *	get_ip_address ()
	Get the internally stored IP address /return IP address of the interface or null if not yet connected.
virtual const char *	get_mac_address ()
	Get the internally stored MAC address /return MAC address of the interface.
virtual void	attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
	Register callback for status reporting.
virtual nsapi_connection_status_t	get_connection_status () const
	Get the connection status.
virtual nsapi_error_t	set_blocking (bool blocking)
	Set blocking status of connect() which by default should be blocking.
int8_t	get_interface_id () const
	Get the interface ID /return Interface identifier.
virtual const char *	get_netmask ()
	Get the local network mask.
virtual const char *	get_gateway ()
	Get the local gateway.
virtual nsapi_error_t	set_network (const char ip_address, const char netmask, const char *gateway)
	Set a static IP address.
virtual nsapi_error_t	set_dhcp (bool dhcp)
	Enable or disable DHCP on the network.
virtual nsapi_error_t	gethostbyname (const char host, SocketAddress address, nsapi_version_t version=NSAPI_UNSPEC)
	Translates a hostname to an IP address with specific version.
virtual nsapi_value_or_error_t	gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC)
	Translates a hostname to an IP address (asynchronous)
virtual nsapi_error_t	gethostbyname_async_cancel (int id)
	Cancels asynchronous hostname translation.
virtual nsapi_error_t	add_dns_server (const SocketAddress &address)
	Add a domain name server to list of servers to query.
virtual EthInterface *	ethInterface ()
	Dynamic downcast to an EthInterface.
virtual WiFiInterface *	wifiInterface ()
	Dynamic downcast to a WiFiInterface.
virtual MeshInterface *	meshInterface ()
	Dynamic downcast to a MeshInterface.
virtual CellularBase *	cellularBase ()
	Dynamic downcast to a CellularBase.
virtual EMACInterface *	emacInterface ()
	Dynamic downcast to an EMACInterface.
Static Public Member Functions
static NetworkInterface *	get_default_instance ()
	Return the default network interface.
static MeshInterface *	get_default_instance ()
	Get the default Mesh interface.
Static Protected Member Functions
static NetworkInterface *	get_target_default_instance ()
	Get the target's default network instance.
static MeshInterface *	get_target_default_instance ()
	Get the target's default Mesh interface.
Friends
class	Socket
class	UDPSocket
class	TCPSocket

Detailed Description

Thread mesh network interface class.

Configure Nanostack to use Thread protocol.

Definition at line 26 of file ThreadInterface.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address) hostbyname_cb_t) [inherited]

Hostname translation callback (asynchronous)

Callback will be called after DNS resolution completes or a failure occurs.

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:

status	0 on success, negative error code on failure
address	On success, destination for the host SocketAddress

Definition at line 181 of file NetworkInterface.h.

Constructor & Destructor Documentation

ThreadInterface ( )

Create an uninitialized ThreadInterface.

Must initialize to initialize the mesh on a phy.

Definition at line 33 of file ThreadInterface.h.

ThreadInterface ( NanostackRfPhy * phy )

Create an initialized ThreadInterface.

Definition at line 38 of file ThreadInterface.h.

Member Function Documentation

nsapi_error_t add_dns_server ( const SocketAddress & address ) [virtual, inherited]

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

Parameters:

address Destination for the host address

Returns:: 0 on success, negative error code on failure

Definition at line 60 of file NetworkInterface_stub.cpp.

void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb ) [virtual, inherited]

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

Definition at line 171 of file MeshInterfaceNanostack.cpp.

virtual CellularBase* cellularBase ( ) [virtual, inherited]

Dynamic downcast to a CellularBase.

Definition at line 263 of file NetworkInterface.h.

void device_eui64_get ( uint8_t * eui64 )

Reads the eui64 from the device configuration.

By default this value is read from the radio driver, but it may have been set by device_eui64_set().

Definition at line 220 of file ThreadInterface.cpp.

void device_eui64_set ( const uint8_t * eui64 )

Sets the eui64 for the device configuration.

By default this value is read from the radio driver. The value must be set before calling the connect function.

Definition at line 215 of file ThreadInterface.cpp.

mesh_error_t device_pskd_set ( const char * pskd )

sets the PSKd for the device configuration.

The default value is overwritten, which is defined in the mbed_lib.json file in the mesh-api The value must be set before calling the connect function.

Returns:: MESH_ERROR_NONE on success.; MESH_ERROR_PARAM in case of illegal parameters.; MESH_ERROR_MEMORY in case of memory error.

Definition at line 244 of file ThreadInterface.cpp.

virtual EMACInterface* emacInterface ( ) [virtual, inherited]

Dynamic downcast to an EMACInterface.

Definition at line 268 of file NetworkInterface.h.

virtual EthInterface* ethInterface ( ) [virtual, inherited]

Dynamic downcast to an EthInterface.

Definition at line 248 of file NetworkInterface.h.

nsapi_connection_status_t get_connection_status ( ) const [virtual, inherited]

Get the connection status.

Returns:: The connection status according to ConnectionStatusType

Definition at line 162 of file MeshInterfaceNanostack.cpp.

MBED_WEAK MeshInterface * get_default_instance ( ) [static, inherited]

Get the default Mesh interface.

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

Returns:: pointer to interface, if any

Definition at line 166 of file LoWPANNDInterface.cpp.

MBED_WEAK NetworkInterface * get_default_instance ( ) [static, inherited]

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 via the ethInterface() etc downcasts.

The default behaviour 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().

Definition at line 60 of file NetworkInterfaceDefaults.cpp.

const char * get_gateway ( ) [virtual, inherited]

Get the local gateway.

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

Definition at line 39 of file NetworkInterface_stub.cpp.

int8_t get_interface_id ( ) const [inherited]

Get the interface ID /return Interface identifier.

Definition at line 106 of file MeshInterfaceNanostack.h.

const char * get_ip_address ( ) [virtual, inherited]

Get the internally stored IP address /return IP address of the interface or null if not yet connected.

Definition at line 146 of file MeshInterfaceNanostack.cpp.

const char * get_mac_address ( ) [virtual, inherited]

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

Definition at line 154 of file MeshInterfaceNanostack.cpp.

const char * get_netmask ( ) [virtual, inherited]

Get the local network mask.

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

Definition at line 34 of file NetworkInterface_stub.cpp.

MBED_WEAK MeshInterface * get_target_default_instance ( ) [static, protected, inherited]

Get the target's default Mesh interface.

This is provided as a weak method so targets can override. The default implementation will invoke LoWPANNDInterface or ThreadInterface with the default NanostackRfPhy.

Returns:: pointer to interface, if any

Definition at line 187 of file MeshInterfaceNanostack.cpp.

MBED_WEAK NetworkInterface * get_target_default_instance ( ) [static, protected, inherited]

Get the target's default network instance.

This method can be overridden by the target. Default implementations are provided weakly by various subsystems as described in NetworkInterface::get_default_instance(), so targets should not need to override in simple cases.

If a target has more elaborate interface selection, it can completely override this behaviour by implementing NetworkInterface::get_target_default_instance() themselves, either unconditionally, or for a specific network-default-interface-type setting

For example, a device with both Ethernet and Wi-fi could be set up its target so that: * DEVICE_EMAC is set, and it provides EMAC::get_default_instance(), which means EthernetInterface provides EthInterface::get_target_instance() based on that EMAC. * It provides WifiInterface::get_target_default_instance(). * The core will route NetworkInterface::get_default_instance() to either of those if network-default-interface-type is set to ETHERNET or WIFI. * The board overrides NetworkInterface::get_target_default_instance() if network-default-interface-type is set to AUTO. This returns either EthInterface::get_default_instance() or WiFIInterface::get_default_instance() depending on a cable detection.

performs the search described by get_default_instance.

Definition at line 74 of file NetworkInterfaceDefaults.cpp.

nsapi_error_t gethostbyname	(	const char *	host,
		SocketAddress *	address,
		nsapi_version_t	version = `NSAPI_UNSPEC`
	)		`[virtual, inherited]`

Translates a hostname to an IP address with specific version.

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	Destination for the host SocketAddress
version	IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)

Returns:: 0 on success, negative error code on failure

Definition at line 55 of file NetworkInterface_stub.cpp.

nsapi_value_or_error_t gethostbyname_async	(	const char *	host,
		hostbyname_cb_t	callback,
		nsapi_version_t	version = `NSAPI_UNSPEC`
	)		`[virtual, inherited]`

Translates a hostname to an IP address (asynchronous)

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.

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)

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

Definition at line 63 of file NetworkInterface.cpp.

nsapi_error_t gethostbyname_async_cancel ( int id ) [virtual, inherited]

Cancels asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters:

id	Unique id of the hostname translation operation

Returns:: 0 on success, negative error code on failure

Definition at line 85 of file NetworkInterface_stub.cpp.

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

Definition at line 85 of file MeshInterfaceNanostack.cpp.

virtual MeshInterface* meshInterface ( ) [virtual, inherited]

Dynamic downcast to a MeshInterface.

Definition at line 258 of file NetworkInterface.h.

nsapi_error_t set_blocking ( bool blocking ) [virtual, inherited]

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

Definition at line 180 of file MeshInterfaceNanostack.cpp.

nsapi_error_t set_dhcp ( bool dhcp ) [virtual, inherited]

Enable or disable DHCP on the network.

Enables DHCP on connecting the network. Defaults to enabled unless a static IP address has been assigned. Requires that the network is disconnected.

Parameters:

dhcp	True to enable DHCP

Returns:: 0 on success, negative error code on failure

Definition at line 49 of file NetworkInterface_stub.cpp.

nsapi_error_t set_network	(	const char *	ip_address,
		const char *	netmask,
		const char *	gateway
	)		`[virtual, inherited]`

Set a static IP address.

Configures this network interface to use a static IP address. Implicitly disables DHCP, which can be enabled in set_dhcp. Requires that the network is disconnected.

Parameters:

ip_address	Null-terminated representation of the local IP address
netmask	Null-terminated representation of the local network mask
gateway	Null-terminated representation of the local gateway

Returns:: 0 on success, negative error code on failure

Definition at line 44 of file NetworkInterface_stub.cpp.

virtual WiFiInterface* wifiInterface ( ) [virtual, inherited]

Dynamic downcast to a WiFiInterface.

Definition at line 253 of file NetworkInterface.h.

Type:	Program
Mbed OS support:	Mbed OS
Created:	21 Jun 2018
Imports:	1
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

Important changes to repositories hosted on mbed.com

ThreadInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

ThreadInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning