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 CellularBase EMACInterface EthInterface InterfaceNanostack MeshInterface WiFiInterface CellularContext EthernetInterface RDAWiFiInterface EthernetInterface NanostackEthernetInterface MeshInterfaceNanostack NanostackEthernetInterface MeshInterfaceNanostack RDAWiFiInterface

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

virtual const char * get_mac_address ()
 Get the local MAC address. More...
 
virtual const char * get_ip_address ()
 Get the local IP address. More...
 
virtual const char * get_netmask ()
 Get the local network mask. More...
 
virtual const char * get_gateway ()
 Get the local gateway. More...
 
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. More...
 
virtual nsapi_error_t set_dhcp (bool dhcp)
 Enable or disable DHCP on connecting the network. More...
 
virtual nsapi_error_t connect ()=0
 Start the interface. More...
 
virtual nsapi_error_t disconnect ()=0
 Stop the interface. More...
 
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. More...
 
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). 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)
 Add a domain name server to 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...
 
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 EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
virtual CellularBasecellularBase ()
 Return pointer to a CellularBase. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. 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 43 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
resultNSAPI_ERROR_OK on success, negative error code on failure.
addressOn success, destination for the host SocketAddress.

Definition at line 196 of file NetworkInterface.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address)
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.

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.

Parameters
status_cbThe callback for status changes.

Reimplemented in CellularContext, EMACInterface, InterfaceNanostack, and AT_CellularContext.

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.

Reimplemented in CellularBase.

Definition at line 290 of file NetworkInterface.h.

virtual nsapi_error_t connect ( )
pure virtual

Start the interface.

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.

Returns
NSAPI_ERROR_OK on success, or if asynchronous operation started.
NSAPI_ERROR_ALREADY if asynchronous connect operation already ongoing.
NSAPI_ERROR_IS_CONNECTED if interface is already connected.
negative error code on failure.

Implemented in CellularContext, RDAWiFiInterface, InterfaceNanostack, WiFiInterface, CellularBase, EMACInterface, and AT_CellularContext.

virtual nsapi_error_t disconnect ( )
pure virtual

Stop the interface.

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 success, or if asynchronous operation started. @
negative error code on failure.

Implemented in CellularContext, RDAWiFiInterface, InterfaceNanostack, WiFiInterface, CellularBase, EMACInterface, 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 298 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 266 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 EMACInterface, and InterfaceNanostack.

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(), cellularBase(), 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 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 CellularContext, EMACInterface, CellularBase, and AT_CellularContext.

virtual 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 CellularContext, EMACInterface, CellularBase, InterfaceNanostack, and AT_CellularContext.

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 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 CellularContext, EMACInterface, CellularBase, and AT_CellularContext.

virtual 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
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).
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 
)
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
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).
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 282 of file NetworkInterface.h.

virtual nsapi_error_t set_blocking ( bool  blocking)
virtual

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

Parameters
blockingUse true to make connect() blocking.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in EMACInterface, InterfaceNanostack, CellularContext, and AT_CellularContext.

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

Reimplemented in EMACInterface.

virtual 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_addressNull-terminated representation of the local IP address
netmaskNull-terminated representation of the local network mask
gatewayNull-terminated representation of the local gateway
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface.

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