CellularContext Class Reference
[Cellular]

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.

Reimplemented from DNS.

Definition at line 253 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.

Definition at line 109 of file NetworkInterface.cpp.

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.

Definition at line 144 of file NetworkInterface.cpp.

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.

Reimplemented from NetworkInterface.

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

Helper method to call callback function if it is provided.

Parameters:

status

connection status which is parameter in callback function

Definition at line 188 of file CellularContext.cpp.

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

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

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

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

Definition at line 70 of file CellularContext.cpp.

Stop the interface.

Returns:

NSAPI_ERROR_OK on success, or error code on failure.

Implements CellularInterface.

Find and activate pdp context or in case of PPP find correct pdp context and open data channel.

Definition at line 183 of file CellularContext.cpp.

Retry logic after device attached to network.

Retry to find and activate pdp context or in case of PPP find correct pdp context and open data channel. Retry logic is the same which is used in CellularStateMachine.

Definition at line 112 of file CellularContext.cpp.

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

Enable or disable hang-up detection.

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. enable_hup() controls whether this function should be active.

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

Get the pdp context id associated with this context.

Returns:

cid

Definition at line 80 of file CellularContext.cpp.

Get the connection status.

Returns:

The connection status (

See also:

nsapi_types.h).

Reimplemented in ESP8266Interface, EMACInterface, L3IPInterface, and PPPInterface.

Definition at line 177 of file NetworkInterface.cpp.

Returns the control plane AT command interface.

Same as NetworkInterface::get_default_instance()

Note:

not to be used if get_default_nonip_instance() was already used

Reimplemented from CellularInterface.

Definition at line 28 of file CellularContext.cpp.

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

Definition at line 44 of file CellularContext.cpp.

Get pointer to CellularDevice instance.

May be null if not AT-layer.

Returns:

pointer to CellularDevice instance

Definition at line 75 of file CellularContext.cpp.

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

Implements CellularInterface.

Get the network interface name.

Returns:

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

Reimplemented in ESP8266Interface, EMACInterface, L3IPInterface, and PPPInterface.

Definition at line 70 of file NetworkInterface.cpp.

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

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.

Definition at line 45 of file NetworkInterface.cpp.

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 ESP8266Interface, and EMACInterface.

Definition at line 30 of file NetworkInterface.cpp.

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

Implements CellularInterface.

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

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

Provide access to the NetworkStack object.

Returns:

The underlying NetworkStack object

Implements NetworkInterface.

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.

Definition at line 94 of file NetworkInterface.cpp.

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.

Definition at line 99 of file NetworkInterface.cpp.

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.

Definition at line 104 of file NetworkInterface.cpp.

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

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

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters:

status_cb

The callback to unregister.

Definition at line 154 of file NetworkInterface.cpp.

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

Definition at line 25 of file NetworkInterface.cpp.

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

Parameters:

type	enum AuthenticationType

Definition at line 85 of file CellularContext.cpp.

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.

Reimplemented from NetworkInterface.

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

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

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.

Definition at line 85 of file NetworkInterface.cpp.

Set the UART serial used to communicate with the modem.

Can be used to change default file handle. File handle set with this method will use data carrier detect to be able to detect disconnection much faster in PPP mode.

Parameters:

serial	UARTSerial used in communication to modem. If null then the default file handle is used.
dcd_pin	Pin used to set data carrier detect on/off for the given UART
active_high	a boolean set to true if DCD polarity is active low

Set the file handle used to communicate with the modem.

You can use this to change the default file handle.

Parameters:

fh	file handle for communicating with the modem

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.

Definition at line 80 of file NetworkInterface.cpp.

Set the plmn.

PLMN controls to what network device registers.

Parameters:

plmn	user to force what network to register.

Implements CellularInterface.

Set the PIN code for SIM card.

Parameters:

sim_pin

PIN for the SIM card.

Implements CellularInterface.

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

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.

Definition at line 90 of file CellularContext.cpp.

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