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 | |
nsapi_error_t | initialize (NanostackRfPhy *phy) |
Attach phy and initialize the mesh. More... | |
virtual nsapi_error_t | connect () |
Start the interface. More... | |
virtual nsapi_error_t | disconnect () |
Stop the interface. More... | |
virtual const char * | get_ip_address () |
Get the internally stored IP address /return IP address of the interface or null if not yet connected. More... | |
virtual const char * | get_mac_address () |
Get the internally stored MAC address /return MAC address of the interface. 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 nsapi_error_t | set_file_system_root_path (const char *root_path) |
Set file system root path. More... | |
int8_t | get_interface_id () const |
Get the interface ID. More... | |
virtual void | set_as_default () |
Set network interface as default one. More... | |
virtual const char * | get_netmask () |
Get the local network mask. More... | |
virtual const char * | get_gateway () |
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 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 | 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 | 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_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... | |
void | add_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) |
Add event listener for interface. More... | |
void | remove_event_listener (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb) |
Remove event listener from interface. 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 CellularInterface * | cellularBase () |
Return pointer to a CellularInterface. More... | |
virtual EMACInterface * | emacInterface () |
Return pointer to an EMACInterface. More... | |
virtual void | set_default_parameters () |
defined(DOXYGEN_ONLY) More... | |
virtual CellularInterface * | cellularInterface () |
Return pointer to a CellularInterface. More... | |
virtual MeshInterface * | meshInterface () |
Return pointer to a MeshInterface. More... | |
Static Public Member Functions | |
static NetworkInterface * | get_default_instance () |
Return the default network interface. More... | |
static MeshInterface * | get_default_instance () |
Get the default Mesh interface. More... | |
Definition at line 170 of file MeshInterfaceNanostack.h.
|
inherited |
Hostname translation callback (for use with gethostbyname_async()).
Callback will be called after DNS resolution completes or a failure occurs.
result | NSAPI_ERROR_OK on success, negative error code on failure. |
address | On success, destination for the host SocketAddress. |
Definition at line 219 of file NetworkInterface.h.
|
virtualinherited |
Add a domain name server to list of servers to query.
address | Address for the dns host. |
Implements DNS.
|
inherited |
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.
status_cb | The callback for status changes. |
|
virtualinherited |
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.
status_cb | The callback for status changes |
Reimplemented from NetworkInterface.
|
virtualinherited |
Return pointer to a CellularInterface.
Reimplemented in CellularInterface.
Definition at line 347 of file NetworkInterface.h.
|
virtualinherited |
Return pointer to a CellularInterface.
Reimplemented in CellularInterface.
Definition at line 424 of file NetworkInterface.h.
|
virtualinherited |
Start the interface.
Implements NetworkInterface.
|
virtualinherited |
Stop the interface.
Implements NetworkInterface.
|
virtualinherited |
Return pointer to an EMACInterface.
Reimplemented in EMACInterface.
Definition at line 355 of file NetworkInterface.h.
|
virtualinherited |
Return pointer to an EthInterface.
Reimplemented in EthInterface.
Definition at line 321 of file NetworkInterface.h.
|
virtualinherited |
Get the connection status.
Reimplemented from NetworkInterface.
|
staticinherited |
Get the default Mesh interface.
This is provided as a weak method so applications can override. Default behavior is to get the target's default interface, if any.
|
staticinherited |
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().
|
virtualinherited |
Get the local gateway.
Reimplemented in CellularContext, EMACInterface, CellularInterface, L3IPInterface, PPPInterface, and AT_CellularContext.
|
inherited |
Get the interface ID.
Definition at line 148 of file MeshInterfaceNanostack.h.
|
virtualinherited |
Get the network interface name.
Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.
|
virtualinherited |
Get the internally stored IP address /return IP address of the interface or null if not yet connected.
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the internally stored MAC address /return MAC address of the interface.
Reimplemented from NetworkInterface.
|
virtualinherited |
Get the local network mask.
Reimplemented in CellularContext, EMACInterface, CellularInterface, L3IPInterface, PPPInterface, and AT_CellularContext.
|
virtualinherited |
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 |
Implements DNS.
|
virtualinherited |
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.
|
virtualinherited |
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.
nsapi_error_t initialize | ( | NanostackRfPhy * | phy | ) |
Attach phy and initialize the mesh.
Initializes a mesh interface on the given phy. Not needed if the phy is passed to the mesh's constructor.
|
virtualinherited |
Return pointer to a MeshInterface.
Reimplemented from NetworkInterface.
Definition at line 33 of file MeshInterface.h.
|
virtualinherited |
Return pointer to a MeshInterface.
Reimplemented in MeshInterface.
Definition at line 337 of file NetworkInterface.h.
|
inherited |
Remove event listener from interface.
Remove previously added callback from the handler list.
status_cb | The callback to unregister. |
|
virtualinherited |
Set network interface as default one.
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
|
virtualinherited |
Set blocking status of connect() which by default should be blocking.
blocking | true if connect is blocking |
Reimplemented from NetworkInterface.
|
virtualinherited |
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.
|
virtualinherited |
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. |
Reimplemented in EMACInterface, and L3IPInterface.
|
virtualinherited |
Set file system root path.
Set file system root path that stack will use to write and read its data. Setting root_path to NULL will disable file system usage.
root_path | Address to NUL-terminated root-path string or NULL to disable file system usage. |
|
virtualinherited |
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 | 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 |
Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.
|
virtualinherited |
Return pointer to a WiFiInterface.
Reimplemented in WiFiInterface.
Definition at line 329 of file NetworkInterface.h.