L3IPInterface class Implementation of the NetworkInterface for an IP-based driver. More...

#include <L3IPInterface.h>

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
	L3IPInterface (L3IP &l3ip=L3IP::get_default_instance(), OnboardNetworkStack &stack=OnboardNetworkStack::get_default_instance())
	Create an L3IP-based network interface.
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	connect ()
	Start the interface.
virtual nsapi_error_t	disconnect ()
	Stop the interface.
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 gateways.
virtual char *	get_interface_name (char *interface_name)
	Get the network interface name.
virtual void	set_as_default ()
	Set the network interface as default one.
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.
L3IP &	getl3ip () const
	Provide access to the L3IP.
virtual const char *	get_mac_address ()
	Get the local MAC address.
virtual nsapi_error_t	get_ip_address (SocketAddress *address)
	Get the local IP address.
virtual nsapi_error_t	get_ipv6_link_local_address (SocketAddress *address)
	Get the IPv6 link local address.
virtual nsapi_error_t	get_netmask (SocketAddress *address)
	Get the local network mask.
virtual nsapi_error_t	get_gateway (SocketAddress *address)
	Get the local gateway.
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.
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.
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.
virtual nsapi_error_t	gethostbyname_async_cancel (int id)
	Cancel asynchronous hostname translation.
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.
void	add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
	Add event listener for interface.
void	remove_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
	Remove event listener from interface.
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 EMACInterface *	emacInterface ()
	Return pointer to an EMACInterface.
virtual CellularInterface *	cellularInterface ()
	Return pointer to a CellularInterface.
virtual void	set_default_parameters ()
	Set default parameters on an interface.
Static Public Member Functions
static NetworkInterface *	get_default_instance ()
	Return the default network interface.
Protected Member Functions
virtual NetworkStack *	get_stack ()
	Provide access to the underlying stack.
Static Protected Member Functions
static NetworkInterface *	get_target_default_instance ()
	Get the target's default network instance.
Friends
class	InternetSocket
class	UDPSocket
class	TCPSocket
class	TCPServer
class	SocketAddress

Detailed Description

L3IPInterface class Implementation of the NetworkInterface for an IP-based driver.

This class provides the necessary glue logic to create a NetworkInterface based on an L3IP and an OnboardNetworkStack. Cellular Interface drivers derive from it.

Drivers derived from L3IPInterface should be constructed so that their L3IP is functional without the need to call `connect()`.

Definition at line 35 of file L3IPInterface.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:

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

Reimplemented from DNS.

Definition at line 253 of file NetworkInterface.h.

Constructor & Destructor Documentation

L3IPInterface	(	L3IP &	l3ip = `L3IP::get_default_instance()`,
		OnboardNetworkStack &	stack = `OnboardNetworkStack::get_default_instance()`
	)

Create an L3IP-based network interface.

The default arguments obtain the default L3IP, which will be target- dependent (and the target may have some JSON option to choose which is the default, if there are multiple). The default stack is configured by JSON option nsapi.default-stack.

Due to inability to return errors from the constructor, no real work is done until the first call to connect().

Parameters:

l3ip	Reference to L3IP to use
stack	Reference to onboard-network stack to use

Definition at line 25 of file L3IPInterface.cpp.

Member Function Documentation

nsapi_error_t add_dns_server	(	const SocketAddress &	address,
		const char *	interface_name
	)		`[virtual, inherited]`

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

Parameters:

address Address for the dns host.

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

Implements DNS.

Definition at line 109 of file NetworkInterface.cpp.

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_cb The callback for status changes.

Definition at line 144 of file NetworkInterface.cpp.

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

Register callback for status reporting.

Parameters:

status_cb The callback for status changes

Reimplemented from NetworkInterface.

Definition at line 139 of file L3IPInterface.cpp.

virtual CellularInterface* cellularInterface ( ) [virtual, inherited]

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

nsapi_error_t connect ( ) [virtual]

Start the interface.

Returns:: 0 on success, negative on failure

Implements NetworkInterface.

Definition at line 64 of file L3IPInterface.cpp.

nsapi_error_t disconnect ( void ) [virtual]

Stop the interface.

Returns:: 0 on success, negative on failure

Implements NetworkInterface.

Definition at line 83 of file L3IPInterface.cpp.

virtual EMACInterface* emacInterface ( ) [virtual, inherited]

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

virtual EthInterface* ethInterface ( ) [virtual, inherited]

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

nsapi_connection_status_t get_connection_status ( ) const [virtual]

Get the connection status.

Returns:: The connection status according to nsapi_connection_status_t

Reimplemented from NetworkInterface.

Definition at line 148 of file L3IPInterface.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 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().

Reimplemented in CellularContext, CellularInterface, EthInterface, MeshInterface, and WiFiInterface.

Definition at line 60 of file NetworkInterfaceDefaults.cpp.

nsapi_error_t get_gateway ( SocketAddress * address ) [virtual, inherited]

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 ESP8266Interface, CellularContext, CellularInterface, EMACInterface, and PPPInterface.

Definition at line 60 of file NetworkInterface.cpp.

const char * get_gateway ( ) [virtual]

Get the local gateways.

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

Definition at line 109 of file L3IPInterface.cpp.

char * get_interface_name ( char * interface_name ) [virtual]

Get the network interface name.

Returns:: Null-terminated representation of the network interface name or null if interface not exists

Reimplemented from NetworkInterface.

Definition at line 118 of file L3IPInterface.cpp.

nsapi_error_t get_ip_address ( SocketAddress * address ) [virtual, inherited]

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 in ESP8266Interface, CellularContext, CellularInterface, EMACInterface, and PPPInterface.

Definition at line 35 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

Definition at line 91 of file L3IPInterface.cpp.

nsapi_error_t get_ipv6_link_local_address ( SocketAddress * address ) [virtual, inherited]

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.

Definition at line 45 of file NetworkInterface.cpp.

const char * get_mac_address ( ) [virtual, inherited]

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 ESP8266Interface, and EMACInterface.

Definition at line 30 of file NetworkInterface.cpp.

nsapi_error_t get_netmask ( SocketAddress * address ) [virtual, inherited]

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 ESP8266Interface, CellularContext, CellularInterface, EMACInterface, and PPPInterface.

Definition at line 50 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

Definition at line 100 of file L3IPInterface.cpp.

NetworkStack * get_stack ( void ) [protected, virtual]

Provide access to the underlying stack.

Returns:: The underlying network stack

Implements NetworkInterface.

Definition at line 134 of file L3IPInterface.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 behavior 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 CellularInterface, EthInterface, MeshInterface, and WiFiInterface.

Definition at line 121 of file NetworkInterfaceDefaults.cpp.

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

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.

Definition at line 94 of file NetworkInterface.cpp.

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`
	)		`[virtual, inherited]`

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.

Definition at line 99 of file NetworkInterface.cpp.

nsapi_error_t gethostbyname_async_cancel ( int id ) [virtual, inherited]

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.

Definition at line 104 of file NetworkInterface.cpp.

L3IP& getl3ip ( ) const

Provide access to the L3IP.

This should be used with care - normally the network stack would control the L3IP, so manipulating the L3IP while the stack is also using it (ie after connect) will likely cause problems.

Returns:: Reference to the L3IP in use

Definition at line 144 of file L3IPInterface.h.

virtual MeshInterface* meshInterface ( ) [virtual, inherited]

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 371 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_cb The callback to unregister.

Definition at line 154 of file NetworkInterface.cpp.

void set_as_default ( ) [virtual]

Set the network interface as default one.

Reimplemented from NetworkInterface.

Definition at line 127 of file L3IPInterface.cpp.

nsapi_error_t set_blocking ( bool blocking ) [virtual]

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.

Definition at line 157 of file L3IPInterface.cpp.

void set_default_parameters ( ) [virtual, inherited]

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.

Definition at line 69 of file NetworkInterfaceDefaults.cpp.

nsapi_error_t set_dhcp ( bool dhcp ) [virtual]

Enable or disable DHCP on the network.

Requires that the network is disconnected

Parameters:

dhcp	False to disable dhcp (defaults to enabled)

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

Reimplemented from NetworkInterface.

Definition at line 56 of file L3IPInterface.cpp.

nsapi_error_t set_network	(	const SocketAddress &	ip_address,
		const SocketAddress &	netmask,
		const SocketAddress &	gateway
	)		`[virtual, inherited]`

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.

Definition at line 80 of file NetworkInterface.cpp.

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

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 42 of file L3IPInterface.cpp.

virtual WiFiInterface* wifiInterface ( ) [virtual, inherited]

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

Type:	Library
Created:	17 Dec 2019
Imports:	79
Forks:	0
Commits:	2
Dependents:	2
Dependencies:	0
Followers:	1

Important changes to repositories hosted on mbed.com

L3IPInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected 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

L3IPInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected 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