Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends
NetworkInterface Class Referenceabstract
Inheritance diagram for NetworkInterface:
DNS CellularBase EMACInterface EthInterface InterfaceNanostack mbed::CellularNetwork MeshInterface WiFiInterface mbed::EasyCellularConnection EthernetInterface EthernetInterface NanostackEthernetInterface MeshInterfaceNanostack NanostackEthernetInterface mbed::AT_CellularNetwork MeshInterfaceNanostack

Public Types

typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t
 
- Public Types inherited from DNS
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t
 

Public Member Functions

virtual const char * get_mac_address ()
 
virtual const char * get_ip_address ()
 
virtual const char * get_netmask ()
 
virtual const char * get_gateway ()
 
virtual nsapi_error_t set_network (const char *ip_address, const char *netmask, const char *gateway)
 
virtual nsapi_error_t set_dhcp (bool dhcp)
 
virtual nsapi_error_t connect ()=0
 
virtual nsapi_error_t disconnect ()=0
 
virtual nsapi_error_t gethostbyname (const char *host, SocketAddress *address, nsapi_version_t version=NSAPI_UNSPEC)
 
virtual nsapi_value_or_error_t gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC)
 
virtual nsapi_error_t gethostbyname_async_cancel (int id)
 
virtual nsapi_error_t add_dns_server (const SocketAddress &address)
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
 
virtual nsapi_connection_status_t get_connection_status () const
 
virtual nsapi_error_t set_blocking (bool blocking)
 
virtual EthInterfaceethInterface ()
 
virtual WiFiInterfacewifiInterface ()
 
virtual MeshInterfacemeshInterface ()
 
virtual CellularBasecellularBase ()
 
virtual EMACInterfaceemacInterface ()
 

Static Public Member Functions

static NetworkInterfaceget_default_instance ()
 

Protected Member Functions

virtual NetworkStackget_stack ()=0
 

Static Protected Member Functions

static NetworkInterfaceget_target_default_instance ()
 

Friends

class Socket
 
class UDPSocket
 
class TCPSocket
 
class TCPServer
 
class SocketAddress
 
template<typename IF >
NetworkStacknsapi_create_stack (IF *iface)
 

Member Typedef Documentation

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
status0 on success, negative error code on failure
addressOn success, destination for the host SocketAddress

Member Function Documentation

nsapi_error_t NetworkInterface::add_dns_server ( const SocketAddress address)
virtual

Add a domain name server to list of servers to query

Parameters
addressDestination for the host address
Returns
0 on success, negative error code on failure

Implements DNS.

void NetworkInterface::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 mbed::CellularNetwork, EMACInterface, mbed::EasyCellularConnection, InterfaceNanostack, and mbed::AT_CellularNetwork.

virtual CellularBase* NetworkInterface::cellularBase ( )
inlinevirtual

Dynamic downcast to a CellularBase

Reimplemented in CellularBase.

virtual nsapi_error_t NetworkInterface::connect ( )
pure virtual
virtual nsapi_error_t NetworkInterface::disconnect ( )
pure virtual

Stop the interface

Returns
0 on success, negative error code on failure

Implemented in WiFiInterface, EMACInterface, mbed::EasyCellularConnection, CellularBase, ThreadInterface, NanostackEthernetInterface, mbed::AT_CellularNetwork, and LoWPANNDInterface.

virtual EMACInterface* NetworkInterface::emacInterface ( )
inlinevirtual

Dynamic downcast to an EMACInterface

Reimplemented in EMACInterface.

virtual EthInterface* NetworkInterface::ethInterface ( )
inlinevirtual

Dynamic downcast to an EthInterface

Reimplemented in EthInterface.

nsapi_connection_status_t NetworkInterface::get_connection_status ( ) const
virtual

Get the connection status

Returns
The connection status according to ConnectionStatusType

Reimplemented in mbed::CellularNetwork, EMACInterface, InterfaceNanostack, and mbed::AT_CellularNetwork.

MBED_WEAK NetworkInterface * 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 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:

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

const char * NetworkInterface::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 EMACInterface, mbed::EasyCellularConnection, and CellularBase.

const char * NetworkInterface::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 EMACInterface, mbed::EasyCellularConnection, CellularBase, mbed::AT_CellularNetwork, and InterfaceNanostack.

const char * NetworkInterface::get_mac_address ( )
virtual

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

Reimplemented in EMACInterface, and InterfaceNanostack.

const char * NetworkInterface::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 EMACInterface, mbed::EasyCellularConnection, and CellularBase.

virtual NetworkStack* NetworkInterface::get_stack ( )
protectedpure virtual

Provide access to the NetworkStack object

Returns
The underlying NetworkStack object

Implemented in EMACInterface, mbed::EasyCellularConnection, InterfaceNanostack, my_AT_CNipv6, my_AT_CN, and mbed::AT_CellularNetwork.

MBED_WEAK NetworkInterface * NetworkInterface::get_target_default_instance ( )
staticprotected

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:

performs the search described by get_default_instance.

nsapi_error_t NetworkInterface::gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC 
)
virtual

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
hostHostname to resolve
addressDestination for the host SocketAddress
versionIP 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

Implements DNS.

nsapi_value_or_error_t NetworkInterface::gethostbyname_async ( const char *  host,
hostbyname_cb_t  callback,
nsapi_version_t  version = NSAPI_UNSPEC 
)
virtual

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

nsapi_error_t NetworkInterface::gethostbyname_async_cancel ( int  id)
virtual

Cancels asynchronous hostname translation

When translation is cancelled, callback will not be called.

Parameters
idUnique id of the hostname translation operation
Returns
0 on success, negative error code on failure

Implements DNS.

virtual MeshInterface* NetworkInterface::meshInterface ( )
inlinevirtual

Dynamic downcast to a MeshInterface

Reimplemented in MeshInterface.

nsapi_error_t NetworkInterface::set_blocking ( bool  blocking)
virtual

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

Parameters
blockingtrue if connect is blocking
Returns
0 on success, negative error code on failure

Reimplemented in mbed::CellularNetwork, EMACInterface, InterfaceNanostack, and mbed::AT_CellularNetwork.

nsapi_error_t NetworkInterface::set_dhcp ( bool  dhcp)
virtual

Enable or disable DHCP on the network

Enables DHCP on connecting the network. Defaults to enabled unless a static IP address has been assigned. Requires that the network is disconnected.

Parameters
dhcpTrue to enable DHCP
Returns
0 on success, negative error code on failure

Reimplemented in EMACInterface.

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

Reimplemented in EMACInterface.

virtual WiFiInterface* NetworkInterface::wifiInterface ( )
inlinevirtual

Dynamic downcast to a WiFiInterface

Reimplemented in WiFiInterface.


The documentation for this class was generated from the following files:
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.