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

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.

Warning

This version of the function does not use the 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.

Parameters

status_cb

The callback for status changes.

Register callback for status reporting.

The specified status callback function is called on the network, and the cellular device status changes. The parameters on the callback are the event type and event type dependent reason parameter.

Remarks

deleting CellularDevice/CellularContext in callback is not allowed.

Allocating/adding lots of traces not recommended as callback is called mostly from State machines thread which is now 2048. You can change to main thread for example via EventQueue.

Parameters

status_cb

The callback for status changes.

Implements CellularContext.

Start the interface.

Attempts to attach the device to cellular network. By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). In synchronous and asynchronous mode, the application can get result in from callback, which is set with attach(...)

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on case of memory failure

Implements CellularContext.

Helper method to call callback function if it is provided.

Parameters

status

connection status which is parameter in callback function

The CellularDevice calls the status callback function on status changes on the network or CellularDevice.

Parameters

ev	event type
ptr	event-type dependent reason parameter

Implements CellularContext.

Enable or disable hang-up detection.

This method will use data carrier detect to be able to detect disconnection much faster in PPP mode.

When in PPP data pump mode, it is helpful if the FileHandle will signal hang-up via POLLHUP, e.g., if the DCD line is deasserted on a UART. During command mode, this signaling is not desired.

Parameters

dcd_pin	Pin used to set data carrier detect on/off for the given UART. NC if feature is disabled.
active_high	a boolean set to true if DCD polarity is active low

Returns

NSAPI_ERROR_OK if success, NSAPI_ERROR_UNSUPPORTED if modem does not support this feature

Implements CellularContext.

Attempt to connect to a cellular network.

If the SIM requires a PIN, and it is invalid or not set, NSAPI_ERROR_AUTH_ERROR is returned.

Returns

NSAPI_ERROR_OK on success, or negative error code on failure.

Implements CellularContext.

Attempt to connect to a cellular network with a PIN and credentials.

Parameters

sim_pin	PIN for the SIM card.
apn	Access point name (optional).
uname	Username (optional).
pwd	Password (optional).

Returns

NSAPI_ERROR_OK on success, or negative error code on failure.

Implements CellularContext.

Triggers control plane's operations needed when control plane data is received, like socket event, for example.

Stop the interface.

Returns

NSAPI_ERROR_OK on success, or error code on failure.

Implements CellularContext.

Activates PDP context or in PPP mode opens data channel.

Can be overridden by the modem target if 3GPP default implementation if not an option

Reimplemented from CellularContext.

Reimplemented in UBLOX_AT_CellularContext.

Does the authentication for the PDP Context if user name and password are provided.

Can be overridden by the modem target if 3GPP default implementation if not an option

Returns

NSAPI_ERROR_OK if no credentials provided or authentication was successful NSAPI_ERROR_AUTH_FAILURE if authentication failed NSAPI_ERROR_DEVICE_ERROR if communication with the modemm failed

Reimplemented in QUECTEL_BG96_CellularContext, QUECTEL_M26_CellularContext, ALT1250_PPP_CellularContext, and QUECTEL_UG96_CellularContext.

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

Get backoff timer value.

Parameters

backoff_timer

Backoff timer value associated with PDP APN in seconds

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_PARAMETER if no access point is set or found when activating context NSAPI_ERROR_DEVICE_ERROR on failure

Implements CellularContext.

Get the pdp context id associated with this context.

Returns

cid

Get the connection status.

Returns

The connection status (

See also

nsapi_types.h).

Reimplemented from NetworkInterface.

Returns the control plane AT command interface.

Implements CellularContext.

Reimplemented in QUECTEL_BG96_CellularContext.

Same as NetworkInterface::get_default_instance()

Note

not to be used if get_default_nonip_instance() was already used

Instantiates a default Non-IP cellular interface.

This function creates a new Non-IP PDP context.

Note

not to be used if get_default_instance() was already used

Returns

A Non-IP cellular PDP context

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.

Parameters

index	Index of the DNS server, starts from zero
address	Destination for the host address
interface_name	Network interface name

Returns

NSAPI_ERROR_OK on success, negative error code on failure

Get the local gateway.

Parameters

address

SocketAddress representation of gateway address

Return values

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, PPPInterface, and UBLOX_AT_CellularContext.

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.

Parameters

address

SocketAddress representation of the local IP address

Return values

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

Implements CellularContext.

Get the IPv6 link local address.

Parameters

address

SocketAddress representation of the link local IPv6 address

Return values

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.

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.

Parameters

address

SocketAddress representation of netmask

Return values

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.

Get string name for NIDD context type.

Returns

NIDD context text, e.g. Non-IP or NONIP

Implements CellularContext.

Reimplemented in UBLOX_N2XX_CellularContext, and QUECTEL_BC95_CellularContext.

Get the relevant information for an active nonsecondary PDP context.

Remarks

optional params are not updated if not received from network.

Parameters

params_list

reference to linked list, which is filled on successful call

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on memory failure NSAPI_ERROR_DEVICE_ERROR on other failures

Implements CellularContext.

Get APN rate control.

Remarks

optional params are not updated if not received from network, so use good defaults

Parameters

reports	Additional exception reports at maximum rate reached are allowed to be sent [optional]
time_unit	Uplink time unit with values 0=unrestricted, 1=minute, 2=hour, 3=day, 4=week [optional]
uplink_rate	Maximum number of messages per timeUnit [optional]

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on case of failure

Implements CellularContext.

Get the operation specific timeout.

Used in synchronous mode when setting the maximum waiting time. Modem specific implementation can override this to provide different timeouts.

Parameters

op	current operation

Returns

timeout in milliseconds

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.

Parameters

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

Returns

number of results on success, negative error code on failure.

Implements DNS.

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.

Parameters

hostname	Hostname to resolve.
hints	Pointer to a SocketAddress with query parameters.
callback	Callback that is called for result.
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.

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

Return values

NSAPI_ERROR_OK	on success
int	Negative error code on failure. See NetworkStack::gethostbyname

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.

Check if the connection is currently established.

Returns

true if the cellular module have successfully acquired a carrier and is connected to an external packet data network using PPP, false otherwise.

Implements CellularContext.

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

Start the interface.

Attempts to register the device to cellular network. By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). In synchronous and asynchronous mode, the application can get result in from callback, which is set with attach(...)

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on case of memory failure

Implements CellularContext.

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

Set the authentication type to be used in user authentication if user name and password are defined.

Parameters

type	enum AuthenticationType

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.

Parameters

blocking

Use false to set NetworkInterface in asynchronous mode.

Returns

NSAPI_ERROR_OK on success

NSAPI_ERROR_UNSUPPORTED if driver does not support asynchronous mode.

negative error code on failure.

Implements CellularContext.

Set the cellular network credentials.

Please check documentation of connect() for default behavior of APN settings.

Parameters

apn	Access point name.
uname	Username (optional).
pwd	Password (optional).

Implements CellularContext.

Start the interface.

Initializes the modem for communication. By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). In synchronous and asynchronous mode application can get result in from callback which is set with attach(...)

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on case of memory failure

Implements CellularContext.

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.

Return values

NSAPI_ERROR_OK	on success.
NSAPI_ERROR_UNSUPPORTED	if operation is not supported.

Reimplemented in EMACInterface, and L3IPInterface.

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

Parameters

mac_addr	Buffer containing the MAC address in hexadecimal format.
addr_len	Length of provided buffer in bytes (6 or 8)

Return values

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.

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_address	SocketAddress object containing the local IP address
netmask	SocketAddress object containing the local network mask
gateway	SocketAddress object containing the local gateway

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this function is unsupported

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

Set the plmn.

PLMN controls to what network device registers.

Parameters

plmn	user to force what network to register.

Implements CellularContext.

Set the PIN code for SIM card.

Parameters

sim_pin

PIN for the SIM card.

Implements CellularContext.

Start the interface.

Attempts to open the SIM. By default, this API is synchronous. API can be set to asynchronous with method set_blocking(...). In synchronous and asynchronous mode, the application can get result in from callback, which is set with attach(...)

Returns

NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on case of memory failure

Implements CellularContext.

Converts the given pdp type in char format to enum pdp_type_t.

Parameters

pdp_type

pdp type in string format

Returns

converted pdp_type_t enum

After we have connected successfully we must check that we have a valid IP address.

Some modems/networks don't give IP address right after connect so we must poll it for a while.

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