![]() |
Mbed OS Reference
|
Common interface that is shared between network devices. More...
#include <NetworkInterface.h>
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 EthInterface * | ethInterface () |
Return pointer to an EthInterface. More... | |
virtual WiFiInterface * | wifiInterface () |
Return pointer to a WiFiInterface. More... | |
virtual MeshInterface * | meshInterface () |
Return pointer to a MeshInterface. More... | |
virtual EMACInterface * | emacInterface () |
Return pointer to an EMACInterface. More... | |
virtual CellularInterface * | cellularInterface () |
Return pointer to a CellularInterface. More... | |
virtual void | set_default_parameters () |
defined(DOXYGEN_ONLY) More... | |
Static Public Member Functions | |
static NetworkInterface * | get_default_instance () |
Return the default network interface. More... | |
Common interface that is shared between network devices.
Definition at line 45 of file NetworkInterface.h.
typedef mbed::Callback<void (nsapi_value_or_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.
result
: Negative error code on failure, or value that represents the number of DNS records
address
: On success, destination for the host SocketAddress.
Definition at line 285 of file NetworkInterface.h.
|
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 |
Set network interface as default one.
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
|
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.
Reimplemented in InterfaceNanostack, and EMACInterface.
|
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
mac_addr | Buffer containing the MAC address in hexadecimal format. |
addr_len | Length of provided buffer in bytes (6 or 8) |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if address is not valid |
NSAPI_ERROR_BUSY | if address can't be set. |
Reimplemented in InterfaceNanostack, and EMACInterface.
|
virtual |
Get the local IP address.
address | SocketAddress representation of the local IP address |
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 AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, PPPInterface, CellularInterface, and CellularContext.
|
virtual |
Get the IPv6 link local address.
address | SocketAddress representation of the link local IPv6 address |
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.
|
virtual |
Get the local network mask.
address | SocketAddress representation of netmask |
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 EMACInterface, L3IPInterface, and PPPInterface.
|
virtual |
Get the local gateway.
address | SocketAddress representation of gateway address |
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 EMACInterface, L3IPInterface, and PPPInterface.
|
virtual |
Get the network interface name.
Reimplemented in AT_CellularContext, EMACInterface, L3IPInterface, and PPPInterface.
|
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.
ip_address | SocketAddress object containing the local IP address |
netmask | SocketAddress object containing the local network mask |
gateway | SocketAddress object containing the local gateway |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this function is unsupported |
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
|
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.
dhcp | True to enable DHCP. |
NSAPI_ERROR_OK | on success. |
NSAPI_ERROR_UNSUPPORTED | if operation is not supported. |
Reimplemented in EMACInterface, and L3IPInterface.
|
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.
Implemented in AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, PPPInterface, CellularInterface, WiFiInterface, and CellularContext.
|
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).
Implemented in AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, PPPInterface, CellularInterface, WiFiInterface, and CellularContext.
|
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.
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 |
NSAPI_ERROR_OK | on success |
int | Negative error code on failure. See NetworkStack::gethostbyname |
Implements DNS.
|
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.
hostname | Hostname to resolve. |
hints | Pointer to a SocketAddress with query parameters. |
res | Pointer to a SocketAddress array to store the result.. |
interface_name | Network interface name |
Implements DNS.
|
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.
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 |
Implements DNS.
|
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.
hostname | Hostname to resolve. |
hints | Pointer to a SocketAddress with query parameters. |
callback | Callback that is called for result. |
interface_name | Network interface name |
Implements DNS.
|
virtual |
Cancel asynchronous hostname translation.
When translation is cancelled, callback will not be called.
id | Unique id of the hostname translation operation (returned by gethostbyname_async) |
Implements DNS.
|
virtual |
Add a domain name server to list of servers to query.
address | Address for the dns host. |
interface_name | Network interface name. Currently unused, the server is added for all interfaces. |
Implements DNS.
|
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.
index | Index of the DNS server, starts from zero |
address | Destination for the host address |
interface_name | Network interface name |
|
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.
status_cb | The callback for status changes. |
Reimplemented in AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, PPPInterface, and CellularContext.
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.
std::nothrow
feature. Subsequently, the function may fail to allocate memory and cause a system error. To use the new version with the changes, set "nsapi.add-event-listener-return-change": 1 in the target overrides section in your mbed_app.json file.status_cb | The callback for status changes. |
|
virtual |
Get the connection status.
Reimplemented in AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, and PPPInterface.
|
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.
blocking | Use false to set NetworkInterface in asynchronous mode. |
Reimplemented in AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, PPPInterface, and CellularContext.
|
virtual |
Return pointer to an EthInterface.
Reimplemented in EthInterface.
Definition at line 445 of file NetworkInterface.h.
|
virtual |
Return pointer to a WiFiInterface.
Reimplemented in WiFiInterface.
Definition at line 453 of file NetworkInterface.h.
|
virtual |
Return pointer to a MeshInterface.
Reimplemented in MeshInterface.
Definition at line 461 of file NetworkInterface.h.
|
virtual |
Return pointer to an EMACInterface.
Reimplemented in EMACInterface.
Definition at line 469 of file NetworkInterface.h.
|
virtual |
Return pointer to a CellularInterface.
Reimplemented in CellularInterface.
Definition at line 477 of file NetworkInterface.h.
|
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 CellularInterface, and WiFiInterface.