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

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.

Create an PPP-based network interface.

The default arguments obtain the default PPP, which will be target- dependent (and the target may have some JSON option to choose which is the default, if there are multiple). The default stack is configured by JSON option nsapi.default-stack.

Due to inability to return errors from the constructor, no real work is done until the first call to connect().

Parameters

ppp	Reference to PPP to use
stack	Reference to onboard-network stack to use

Add a domain name server to list of servers to query.

Parameters

address

Address for the dns host.

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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_cb

The callback for status changes.

Register callback for status reporting.

Parameters

status_cb

The callback for status changes

Reimplemented from NetworkInterface.

Return pointer to a CellularInterface.

Returns

Pointer to requested interface type or NULL if this class doesn't implement the interface.

Deprecated:

CellularBase migrated to CellularInterface - use cellularInterface()

Reimplemented in CellularInterface.

Definition at line 347 of file NetworkInterface.h.

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

Start the interface.

Returns

0 on success, negative on failure

Implements NetworkInterface.

Stop the interface.

Returns

0 on success, negative on failure

Implements NetworkInterface.

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

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

Get the connection status.

Returns

The connection status according to nsapi_connection_status_t

Reimplemented from NetworkInterface.

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:

• ETHERNET: EthernetInterface, using default EMAC and OnboardNetworkStack
• MESH: ThreadInterface or LoWPANNDInterface, using default NanostackRfPhy
• CELLULAR: OnboardModemInterface
• WIFI: None - always provided by a specific class

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

Get the local gateways.

Returns

Null-terminated representation of the local gateway or null if no network mask has been received

Reimplemented from NetworkInterface.

Get the network interface name.

Returns

Null-terminated representation of the network interface name or null if interface not exists

Reimplemented from NetworkInterface.

Get the local IP address.

Returns

Null-terminated representation of the local IP address or null if no IP address has been received

Reimplemented from NetworkInterface.

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.

Get the local network mask.

Returns

Null-terminated representation of the local network mask or null if no network mask has been received

Reimplemented from NetworkInterface.

Provide access to the underlying stack.

Returns

The underlying network stack

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

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

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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

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

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.

Cancel asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters

id	Unique id of the hostname translation operation (returned by gethostbyname_async)

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

Provide access to the PPP.

This should be used with care - normally the network stack would control the PPP, so manipulating the PPP while the stack is also using it (ie after connect) will likely cause problems.

Returns

Reference to the PPP in use

Definition at line 154 of file PPPInterface.h.

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

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters

status_cb

The callback to unregister.

Set the network interface as default one.

Reimplemented from NetworkInterface.

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

Parameters

blocking

true if connect is blocking

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

Sets user name and password for PPP protocol.

Parameters

uname	User name
password	Password

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.

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

dhcp	True to enable DHCP.

Returns

NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in EMACInterface, and L3IPInterface.

Sets IP protocol versions of IP stack.

Parameters

ip_stack

IP protocol version

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

Returns

0 on success, negative error code on failure

Reimplemented from NetworkInterface.

Sets file stream used to communicate with modem.

Parameters

stream

Pointer to file handle

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