Common interface that is shared between network devices. More...

#include <NetworkInterface.h>

Inherits DNS.

Inherited by CellularBase, EMACInterface [virtual], EthInterface [virtual], InterfaceNanostack [virtual], CellularNetwork, MeshInterface [virtual], and WiFiInterface [virtual].

Public Types
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)	hostbyname_cb_t )
	Hostname translation callback (for use with gethostbyname_async()).
Public Member Functions
virtual const char *	get_mac_address ()
	Get the local MAC address.
virtual const char *	get_ip_address ()
	Get the local IP address.
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)
	Configure this network interface to use a static IP address.
virtual nsapi_error_t	set_dhcp (bool dhcp)
	Enable or disable DHCP on connecting the network.
virtual nsapi_error_t	connect ()=0
	Start the interface.
virtual nsapi_error_t	disconnect ()=0
	Stop the interface.
virtual nsapi_error_t	gethostbyname (const char host, SocketAddress address, nsapi_version_t version=NSAPI_UNSPEC)
	Translate 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)
	Translate a hostname to an IP address (asynchronous).
virtual nsapi_error_t	gethostbyname_async_cancel (int id)
	Cancel 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 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.
virtual EthInterface *	ethInterface ()
	Return pointer to an EthInterface.
virtual WiFiInterface *	wifiInterface ()
	Return pointer to a WiFiInterface.
virtual MeshInterface *	meshInterface ()
	Return pointer to a MeshInterface.
virtual CellularBase *	cellularBase ()
	Return pointer to a CellularBase.
virtual EMACInterface *	emacInterface ()
	Return pointer to an EMACInterface.
Static Public Member Functions
static NetworkInterface *	get_default_instance ()
	Return the default network interface.
Protected Member Functions
virtual NetworkStack *	get_stack ()=0
	Provide access to the NetworkStack object.
Static Protected Member Functions
static NetworkInterface *	get_target_default_instance ()
	Get the target's default network instance.
Friends
class	InternetSocket
class	UDPSocket
class	TCPSocket

Detailed Description

Common interface that is shared between network devices.

\addtogroup netsocket

Definition at line 39 of file NetworkInterface.h.

Member Typedef Documentation

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

Hostname translation callback (for use with gethostbyname_async()).

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

Note:: Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.

Parameters:

result	NSAPI_ERROR_OK on success, negative error code on failure.
address	On success, destination for the host SocketAddress.

Definition at line 178 of file NetworkInterface.h.

Member Function Documentation

nsapi_error_t add_dns_server ( const SocketAddress & address ) [virtual]

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

Parameters:

address Address for the dns host.

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

Definition at line 73 of file NetworkInterface.cpp.

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

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 in EasyCellularConnection, CellularNetwork, and EMACInterface.

Definition at line 78 of file NetworkInterface.cpp.

virtual CellularBase* cellularBase ( ) [virtual]

Return pointer to a CellularBase.

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

Definition at line 272 of file NetworkInterface.h.

virtual nsapi_error_t connect ( ) [pure virtual]

Start the interface.

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

Implemented in EasyCellularConnection, CellularNetwork, AT_CellularNetwork, and EMACInterface.

virtual nsapi_error_t disconnect ( ) [pure virtual]

Stop the interface.

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

Implemented in EasyCellularConnection, AT_CellularNetwork, and EMACInterface.

virtual EMACInterface* emacInterface ( ) [virtual]

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

virtual EthInterface* ethInterface ( ) [virtual]

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

nsapi_connection_status_t get_connection_status ( ) const [virtual]

Get the connection status.

Returns:: The connection status (

See also:: nsapi_types.h).

Reimplemented in CellularNetwork, AT_CellularNetwork, and EMACInterface.

Definition at line 82 of file NetworkInterface.cpp.

MBED_WEAK NetworkInterface * get_default_instance ( ) [static]

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(), cellularBase(), emacInterface() and checking for NULL pointers.

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

Reimplemented in EthInterface, and MeshInterface.

Definition at line 60 of file NetworkInterfaceDefaults.cpp.

const char * get_gateway ( ) [virtual]

Get the local gateway.

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

Reimplemented in EasyCellularConnection, and EMACInterface.

Definition at line 38 of file NetworkInterface.cpp.

const char * get_ip_address ( ) [virtual]

Get the local IP address.

Returns:: Null-terminated representation of the local IP address or null if no IP address has been received.

Reimplemented in EasyCellularConnection, AT_CellularNetwork, and EMACInterface.

Definition at line 28 of file NetworkInterface.cpp.

const char * get_mac_address ( ) [virtual]

Get the local MAC address.

Provided MAC address is intended for info or debug purposes and may be not provided if the underlying network interface does not provide a MAC address.

Returns:: Null-terminated representation of the local MAC address or null if no MAC address is available.

Reimplemented in EMACInterface.

Definition at line 23 of file NetworkInterface.cpp.

const char * get_netmask ( ) [virtual]

Get the local network mask.

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

Reimplemented in EasyCellularConnection, and EMACInterface.

Definition at line 33 of file NetworkInterface.cpp.

virtual NetworkStack* get_stack ( ) [protected, pure virtual]

Provide access to the NetworkStack object.

Returns:: The underlying NetworkStack object

Implemented in EasyCellularConnection, AT_CellularNetwork, PPPCellularInterface, and EMACInterface.

MBED_WEAK NetworkInterface * get_target_default_instance ( ) [static, protected]

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.

Reimplemented in EthInterface, and MeshInterface.

Definition at line 74 of file NetworkInterfaceDefaults.cpp.

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

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

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

Definition at line 58 of file NetworkInterface.cpp.

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

Translate a hostname to an IP address (asynchronous).

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

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]

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.

Definition at line 68 of file NetworkInterface.cpp.

virtual MeshInterface* meshInterface ( ) [virtual]

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

nsapi_error_t set_blocking ( bool blocking ) [virtual]

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

Parameters:

blocking Use true to make connect() blocking.

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

Reimplemented in CellularNetwork, AT_CellularNetwork, and EMACInterface.

Definition at line 87 of file NetworkInterface.cpp.

nsapi_error_t set_dhcp ( bool dhcp ) [virtual]

Enable or disable DHCP on connecting the network.

Enabled by default unless a static IP address has been assigned. Requires that the network is disconnected.

Parameters:

dhcp	True to enable DHCP.

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

Reimplemented in EMACInterface.

Definition at line 48 of file NetworkInterface.cpp.

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

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	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:: NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface.

Definition at line 43 of file NetworkInterface.cpp.

virtual WiFiInterface* wifiInterface ( ) [virtual]

Return pointer to a WiFiInterface.

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

Definition at line 256 of file NetworkInterface.h.

Type:	Program
Created:	12 Feb 2019
Imports:	15
Forks:	0
Commits:	7
Dependents:	0
Dependencies:	3
Followers:	1

Important changes to repositories hosted on mbed.com

NetworkInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

NetworkInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning