Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Static Public Member Functions
MeshInterfaceNanostack Class Referenceabstract
Inheritance diagram for MeshInterfaceNanostack:
InterfaceNanostack MeshInterface NonCopyable< MeshInterfaceNanostack > NetworkInterface NetworkInterface DNS DNS LoWPANNDInterface ThreadInterface WisunInterface

Public Types

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

Public Member Functions

nsapi_error_t initialize (NanostackRfPhy *phy)
 Attach phy and initialize the mesh. More...
 
virtual nsapi_error_t connect ()
 Start the interface. More...
 
virtual nsapi_error_t disconnect ()
 Stop the interface. More...
 
virtual nsapi_error_t get_ip_address (SocketAddress *address)
 Get the local IP address. More...
 
virtual const char * get_mac_address ()
 Get the internally stored MAC address /return MAC address of the interface. More...
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Register callback for status reporting. More...
 
virtual nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
virtual nsapi_error_t set_blocking (bool blocking)
 Set blocking status of connect() which by default should be blocking. More...
 
virtual 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 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 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_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...
 
void add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Add event listener for interface. More...
 
void remove_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Remove event listener from interface. More...
 
virtual EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
virtual CellularInterfacecellularBase ()
 Return pointer to a CellularInterface. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 

Static Public Member Functions

static NetworkInterfaceget_default_instance ()
 Return the default network interface. More...
 
static MeshInterfaceget_default_instance ()
 Get the default Mesh interface. More...
 

Detailed Description

Definition at line 180 of file MeshInterfaceNanostack.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_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.
Parameters
resultNSAPI_ERROR_OK on success, negative error code on failure.
addressOn success, destination for the host SocketAddress.

Definition at line 249 of file NetworkInterface.h.

Member Function Documentation

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
addressAddress for the dns host.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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.

Parameters
status_cbThe callback for status changes.
virtual void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
virtualinherited

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_cbThe callback for status changes

Reimplemented from NetworkInterface.

virtual CellularInterface* cellularBase ( )
virtualinherited

Return pointer to a CellularInterface.

Returns
Pointer to requested interface type or NULL if this class doesn't implement the interface.
Deprecated:
CellularBase migrated to CellularInterface - use cellularInterface()

Reimplemented in CellularInterface.

Definition at line 377 of file NetworkInterface.h.

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

virtual nsapi_error_t connect ( )
virtualinherited

Start the interface.

Returns
0 on success, negative error code on failure

Implements NetworkInterface.

virtual nsapi_error_t disconnect ( )
virtualinherited

Stop the interface.

Returns
0 on success, negative error code on failure

Implements NetworkInterface.

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

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

virtual nsapi_connection_status_t get_connection_status ( ) const
virtualinherited

Get the connection status.

Returns
The connection status according to ConnectionStatusType

Reimplemented from NetworkInterface.

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

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

virtual nsapi_error_t get_gateway ( SocketAddress address)
virtualinherited

Get the local gateway.

Parameters
addressSocketAddress representation of gateway address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in CellularContext, EMACInterface, CellularInterface, PPPInterface, and AT_CellularContext.

int8_t get_interface_id ( ) const
inherited

Get the interface ID.

Returns
Interface identifier

Definition at line 157 of file MeshInterfaceNanostack.h.

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

virtual nsapi_error_t get_ip_address ( SocketAddress address)
virtualinherited

Get the local IP address.

Parameters
addressSocketAddress representation of the local IP address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtualinherited

Get the IPv6 link local address.

Parameters
addressSocketAddress representation of the link local IPv6 address
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid

Reimplemented in EMACInterface.

virtual const char* get_mac_address ( )
virtualinherited

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

Reimplemented from NetworkInterface.

virtual nsapi_error_t get_netmask ( SocketAddress address)
virtualinherited

Get the local network mask.

Parameters
addressSocketAddress representation of netmask
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif the provided pointer is invalid
NSAPI_ERROR_NO_ADDRESSif the address cannot be obtained from stack

Reimplemented in CellularContext, EMACInterface, CellularInterface, PPPInterface, and AT_CellularContext.

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
hostHostname to resolve.
addressPointer to a SocketAddress to store the result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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
hostHostname to resolve.
callbackCallback that is called for result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork 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.

virtual nsapi_error_t gethostbyname_async_cancel ( int  id)
virtualinherited

Cancel asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters
idUnique id of the hostname translation operation (returned by gethostbyname_async)
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

nsapi_error_t initialize ( NanostackRfPhy phy)

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

Definition at line 33 of file MeshInterface.h.

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

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

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters
status_cbThe callback to unregister.
virtual void set_as_default ( )
virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

virtual nsapi_error_t set_blocking ( bool  blocking)
virtualinherited

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

Parameters
blockingtrue if connect is blocking
Returns
0 on success, negative error code on failure

Reimplemented from NetworkInterface.

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.

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
dhcpTrue to enable DHCP.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in EMACInterface, and L3IPInterface.

virtual nsapi_error_t set_file_system_root_path ( const char *  root_path)
virtualinherited

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_pathAddress 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.
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_addressSocketAddress object containing the local IP address
netmaskSocketAddress object containing the local network mask
gatewaySocketAddress object containing the local gateway
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface.

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

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.