Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Static Public Member Functions
NetworkInterface Class Referenceabstract

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

#include <NetworkInterface.h>

Inheritance diagram for NetworkInterface:
DNS CellularInterface EMACInterface EthInterface InterfaceNanostack L3IPInterface MeshInterface PPPInterface WiFiInterface

Public Types

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

Public Member Functions

virtual void set_as_default ()
 Set network interface as default one. More...
 
virtual const char * get_mac_address ()
 Get the local MAC address. More...
 
virtual nsapi_error_t set_mac_address (uint8_t *mac_addr, nsapi_size_t addr_len)
 Set the MAC address to the interface. More...
 
virtual nsapi_error_t get_ip_address (SocketAddress *address)
 Get the local IP address. 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 connect ()=0
 Connect to a network. More...
 
virtual nsapi_error_t disconnect ()=0
 Disconnect from 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 getaddrinfo (const char *hostname, SocketAddress *hints, SocketAddress **res, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses 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_value_or_error_t getaddrinfo_async (const char *hostname, SocketAddress *hints, hostbyname_cb_t callback, const char *interface_name=NULL)
 Translate a hostname to the multiple IP addresses (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...
 
virtual nsapi_error_t get_dns_server (int index, SocketAddress *address, const char *interface_name=NULL)
 Get a domain name server from a list of servers to query. More...
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Register callback for status reporting. More...
 
void add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 Add event listener for interface. More...
 
virtual nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
virtual nsapi_error_t set_blocking (bool blocking)
 Set asynchronous operation of connect() and disconnect() calls. 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 EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 

Static Public Member Functions

static NetworkInterfaceget_default_instance ()
 Return the default network interface. More...
 

Detailed Description

Common interface that is shared between network devices.

Definition at line 45 of file NetworkInterface.h.

Member Typedef Documentation

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
resultNegative error code on failure or value that represents the number of DNS records
addressOn success, destination for the host SocketAddress.

Definition at line 284 of file NetworkInterface.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address,
const char *  interface_name 
)
virtual

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)

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)
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. Only one callback can be registered at a time.

To unregister a callback call with status_cb parameter as a zero.

NOTE: Any callbacks registered with this function will be overwritten if add_event_listener() API is used.

Parameters
status_cbThe callback for status changes.

Reimplemented in CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

virtual CellularInterface* cellularInterface ( )
virtual

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

virtual nsapi_error_t connect ( )
pure virtual

Connect to a network.

This blocks until connection is established, but asynchronous operation can be enabled by calling NetworkInterface::set_blocking(false).

In asynchronous mode this starts the connection sequence and returns immediately. Status of the connection can then checked from NetworkInterface::get_connection_status() or from status callbacks.

NetworkInterface internally handles reconnections until disconnect() is called.

Returns
NSAPI_ERROR_OK if connection established in blocking mode.
NSAPI_ERROR_OK if asynchronous operation started.
NSAPI_ERROR_BUSY if asynchronous operation cannot be started. Implementation guarantees event generation, which can be used as an trigger to reissue the rejected request.
NSAPI_ERROR_IS_CONNECTED if already connected.
negative error code on failure.

Implemented in CellularContext, RDAWiFiInterface, InterfaceNanostack, WiFiInterface, CellularInterface, EMACInterface, L3IPInterface, WhdSTAInterface, SclSTAInterface, PPPInterface, and AT_CellularContext.

virtual nsapi_error_t disconnect ( )
pure virtual

Disconnect from the network.

This blocks until interface is disconnected, unless interface is set to asynchronous (non-blocking) mode by calling NetworkInterface::set_blocking(false).

Returns
NSAPI_ERROR_OK on successfully disconnected in blocking mode.
NSAPI_ERROR_OK if asynchronous operation started.
NSAPI_ERROR_BUSY if asynchronous operation cannot be started. Implementation guarantees event generation, which can be used as an trigger to reissue the rejected request.
NSAPI_ERROR_NO_CONNECTION if already disconnected.
negative error code on failure.

Implemented in CellularContext, RDAWiFiInterface, InterfaceNanostack, WhdSTAInterface, WiFiInterface, CellularInterface, SclSTAInterface, EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.

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

virtual nsapi_connection_status_t get_connection_status ( ) const
virtual

Get the connection status.

Returns
The connection status (
See also
nsapi_types.h).

Reimplemented in InterfaceNanostack, L3IPInterface, EMACInterface, PPPInterface, and AT_CellularContext.

static 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(), 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_dns_server ( int  index,
SocketAddress address,
const char *  interface_name = NULL 
)
virtual

Get a domain name server from a list of servers to query.

Returns a DNS server address for a index. If returns error no more DNS servers to read.

Parameters
indexIndex of the DNS server, starts from zero
addressDestination for the host address
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure
virtual nsapi_error_t get_gateway ( SocketAddress address)
virtual

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

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

virtual nsapi_error_t get_ip_address ( SocketAddress address)
virtual

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

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress address)
virtual

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 ( )
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 InterfaceNanostack, and EMACInterface.

virtual nsapi_error_t get_netmask ( SocketAddress address)
virtual

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

virtual nsapi_value_or_error_t getaddrinfo ( const char *  hostname,
SocketAddress hints,
SocketAddress **  res,
const char *  interface_name = NULL 
)
virtual

Translate a hostname to the multiple IP addresses 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
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
resPointer to a SocketAddress array to store the result..
interface_nameNetwork interface name
Returns
number of results on success, negative error code on failure.

Implements DNS.

virtual nsapi_value_or_error_t getaddrinfo_async ( const char *  hostname,
SocketAddress hints,
hostbyname_cb_t  callback,
const char *  interface_name = NULL 
)
virtual

Translate a hostname to the multiple IP addresses (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
hostnameHostname to resolve.
hintsPointer to a SocketAddress with query parameters.
callbackCallback that is called for result.
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 ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
virtual

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
Return values
NSAPI_ERROR_OKon success
intNegative error code on failure. See NetworkStack::gethostbyname

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

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

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.

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

virtual void set_as_default ( )
virtual

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

virtual nsapi_error_t set_blocking ( bool  blocking)
virtual

Set asynchronous operation of connect() and disconnect() calls.

By default, interfaces are in synchronous mode which means that connect() or disconnect() blocks until it reach the target state or requested operation fails.

Parameters
blockingUse false to set NetworkInterface in asynchronous mode.
Returns
NSAPI_ERROR_OK on success
NSAPI_ERROR_UNSUPPORTED if driver does not support asynchronous mode.
negative error code on failure.

Reimplemented in WhdSoftAPInterface, CellularContext, InterfaceNanostack, WhdSTAInterface, L3IPInterface, SclSTAInterface, EMACInterface, PPPInterface, and AT_CellularContext.

virtual void set_default_parameters ( )
virtual

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 WiFiInterface, and CellularInterface.

virtual 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
dhcpTrue to enable DHCP.
Return values
NSAPI_ERROR_OKon success.
NSAPI_ERROR_UNSUPPORTEDif operation is not supported.

Reimplemented in EMACInterface, and L3IPInterface.

virtual nsapi_error_t set_mac_address ( uint8_t *  mac_addr,
nsapi_size_t  addr_len 
)
virtual

Set the MAC address to the interface.

Set the provided MAC address on the network interface. The address must be unique globally. The address must be set before calling the interface connect() method.

Not all interfaces are supporting MAC address set and an error is not returned for this method call. Verify the changed MAC address by checking packet captures from the used network interface.

6-byte EUI-48 MAC addresses are used for Ethernet while Mesh interface is using 8-byte EUI-64 address.

More information about obtaining MAC address can be found from: https://standards.ieee.org/products-services/regauth/index.html

Parameters
mac_addrBuffer containing the MAC address in hexadecimal format.
addr_lenLength of provided buffer in bytes (6 or 8)
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this feature is not supported
NSAPI_ERROR_PARAMETERif address is not valid
NSAPI_ERROR_BUSYif address can't be set.

Reimplemented in InterfaceNanostack, and EMACInterface.

virtual nsapi_error_t set_network ( const SocketAddress ip_address,
const SocketAddress netmask,
const SocketAddress 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_addressSocketAddress object containing the local IP address
netmaskSocketAddress object containing the local network mask
gatewaySocketAddress object containing the local gateway
Return values
NSAPI_ERROR_OKon success
NSAPI_ERROR_UNSUPPORTEDif this function is unsupported

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

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.

Reimplemented in WiFiInterface.

Definition at line 432 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.