EthernetInterface class Implementation of the NetworkStack for an EMAC-based Ethernet driver. More...

#include <EthernetInterface.h>

Inherits EMACInterface, and EthInterface.

Public Types
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)	hostbyname_cb_t )
	Hostname translation callback (asynchronous)
Public Member Functions
	EthernetInterface (EMAC &emac=EMAC::get_default_instance(), OnboardNetworkStack &stack=OnboardNetworkStack::get_default_instance())
	Create an EMAC-based ethernet 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_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 gateways.
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.
EMAC &	get_emac () const
	Provide access to the EMAC.
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.
Static Public Member Functions
static NetworkInterface *	get_default_instance ()
	Return the default network interface.
static EthInterface *	get_default_instance ()
	Get the default Ethernet 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.
static EthInterface *	get_target_default_instance ()
	Get the target's default Ethernet interface.
Friends
class	InternetSocket
class	UDPSocket
class	TCPSocket

Detailed Description

EthernetInterface class Implementation of the NetworkStack for an EMAC-based Ethernet driver.

Definition at line 28 of file EthernetInterface.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 180 of file NetworkInterface.h.

Constructor & Destructor Documentation

EthernetInterface	(	EMAC &	emac = `EMAC::get_default_instance()`,
		OnboardNetworkStack &	stack = `OnboardNetworkStack::get_default_instance()`
	)

Create an EMAC-based ethernet interface.

The default arguments obtain the default EMAC, 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:

emac	Reference to EMAC to use
stack	Reference to onboard-network stack to use

Definition at line 43 of file EthernetInterface.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 73 of file NetworkInterface.cpp.

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

Register callback for status reporting.

Parameters:

status_cb The callback for status changes

virtual CellularBase* cellularBase ( ) [virtual, inherited]

Dynamic downcast to a CellularBase.

Definition at line 265 of file NetworkInterface.h.

nsapi_error_t connect ( ) [virtual, inherited]

Start the interface.

Returns:: 0 on success, negative on failure

Definition at line 52 of file EMACInterface.cpp.

nsapi_error_t disconnect ( void ) [virtual, inherited]

Stop the interface.

Returns:: 0 on success, negative on failure

Definition at line 71 of file EMACInterface.cpp.

virtual EthInterface* ethInterface ( ) [virtual, inherited]

Dynamic downcast to an EthInterface.

Definition at line 247 of file NetworkInterface.h.

nsapi_connection_status_t get_connection_status ( ) const [virtual, inherited]

Get the connection status.

Returns:: The connection status according to nsapi_connection_status_t

Definition at line 128 of file EMACInterface.cpp.

MBED_WEAK EthInterface * get_default_instance ( ) [static, inherited]

Get the default Ethernet 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 28 of file NetworkInterfaceDefaults.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.

EMAC& get_emac ( ) const [inherited]

Provide access to the EMAC.

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

Returns:: Reference to the EMAC in use

Definition at line 148 of file EMACInterface.h.

const char * get_gateway ( ) [virtual, inherited]

Get the local gateways.

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

Definition at line 105 of file EMACInterface.cpp.

const char * get_ip_address ( ) [virtual, inherited]

Get the local IP address.

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

Definition at line 87 of file EMACInterface.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 not be 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

Definition at line 79 of file EMACInterface.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 recieved

Definition at line 96 of file EMACInterface.cpp.

NetworkStack * get_stack ( void ) [protected, virtual, inherited]

Provide access to the underlying stack.

Returns:: The underlying network stack

Definition at line 114 of file EMACInterface.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.

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

Get the target's default Ethernet interface.

This is provided as a weak method so targets can override. The default implementation will invoke EthernetInterface with the default EMAC and default network stack, if DEVICE_EMAC is set.

Returns:: pointer to interface, if any

Definition at line 24 of file EthernetInterface.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 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, 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 68 of file NetworkInterface.cpp.

virtual MeshInterface* meshInterface ( ) [virtual, inherited]

Dynamic downcast to a MeshInterface.

Definition at line 259 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 137 of file EMACInterface.cpp.

nsapi_error_t set_dhcp ( bool dhcp ) [virtual, inherited]

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

Definition at line 46 of file EMACInterface.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 32 of file EMACInterface.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:	11 Oct 2018
Imports:	23
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	1
Followers:	1

Important changes to repositories hosted on mbed.com

EthernetInterface 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

EthernetInterface 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