Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
CellularContext Class Referenceabstract

CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity. More...

#include <CellularContext.h>

Inheritance diagram for CellularContext:
CellularInterface NetworkInterface DNS AT_CellularContext

Data Structures

struct  pdpcontext_params_t
 PDP Context information. More...
 

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

virtual nsapi_error_t set_blocking (bool blocking)=0
 Set asynchronous operation of connect() and disconnect() calls. More...
 
virtual const char * get_ip_address ()=0
 Get the local IP address. More...
 
virtual void attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)=0
 Register callback for status reporting. More...
 
virtual nsapi_error_t connect ()=0
 Attempt to connect to a cellular network. More...
 
virtual nsapi_error_t disconnect ()=0
 Stop the interface. More...
 
virtual void set_plmn (const char *plmn)=0
 Set the plmn. More...
 
virtual void set_sim_pin (const char *sim_pin)=0
 Set the PIN code for SIM card. More...
 
virtual nsapi_error_t connect (const char *sim_pin, const char *apn=0, const char *uname=0, const char *pwd=0)=0
 Attempt to connect to a cellular network with a PIN and credentials. More...
 
virtual void set_credentials (const char *apn, const char *uname=0, const char *pwd=0)=0
 Set the cellular network credentials. More...
 
virtual const char * get_netmask ()=0
 Get the local network mask. More...
 
virtual const char * get_gateway ()=0
 Get the local gateways. More...
 
virtual bool is_connected ()=0
 Check if the connection is currently established. More...
 
virtual nsapi_error_t set_device_ready ()=0
 Start the interface. More...
 
virtual nsapi_error_t set_sim_ready ()=0
 Start the interface. More...
 
virtual nsapi_error_t register_to_network ()=0
 Start the interface. More...
 
virtual nsapi_error_t attach_to_network ()=0
 Start the interface. More...
 
virtual nsapi_error_t get_rate_control (CellularContext::RateControlExceptionReports &reports, CellularContext::RateControlUplinkTimeUnit &time_unit, int &uplink_rate)=0
 Get APN rate control. More...
 
virtual nsapi_error_t get_pdpcontext_params (pdpContextList_t &params_list)=0
 Get the relevant information for an active nonsecondary PDP context. More...
 
virtual nsapi_error_t get_apn_backoff_timer (int &backoff_timer)=0
 Get backoff timer value. More...
 
virtual void set_file_handle (FileHandle *fh)=0
 Set the file handle used to communicate with the modem. More...
 
virtual void set_file_handle (UARTSerial *serial, PinName dcd_pin=NC, bool active_high=false)=0
 Set the UART serial used to communicate with the modem. More...
 
virtual ControlPlane_netifget_cp_netif ()=0
 Returns the control plane AT command interface. More...
 
virtual CellularInterfacecellularBase ()
 Return pointer to a CellularInterface. More...
 
virtual CellularInterfacecellularInterface ()
 Return pointer to a CellularInterface. More...
 
virtual void set_default_parameters ()
 defined(DOXYGEN_ONLY) More...
 
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 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 nsapi_connection_status_t get_connection_status () const
 Get the connection status. More...
 
virtual EthInterfaceethInterface ()
 Return pointer to an EthInterface. More...
 
virtual WiFiInterfacewifiInterface ()
 Return pointer to a WiFiInterface. More...
 
virtual MeshInterfacemeshInterface ()
 Return pointer to a MeshInterface. More...
 
virtual EMACInterfaceemacInterface ()
 Return pointer to an EMACInterface. More...
 

Static Public Member Functions

static CellularContextget_default_instance ()
 Same as NetworkInterface::get_default_instance() More...
 
static CellularContextget_default_nonip_instance ()
 Instantiates a default Non-IP cellular interface. More...
 

Protected Member Functions

virtual void cellular_callback (nsapi_event_t ev, intptr_t ptr)=0
 The CellularDevice calls the status callback function on status changes on the network or CellularDevice. More...
 
virtual void enable_hup (bool enable)=0
 Enable or disable hang-up detection. More...
 
void cp_data_received ()
 Triggers control plane's operations needed when control plane data is received, like socket event, for example. More...
 

Detailed Description

CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity.

Definition at line 46 of file CellularContext.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t
inherited

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
resultNSAPI_ERROR_OK on success, negative error code on failure.
addressOn success, destination for the host SocketAddress.

Definition at line 218 of file NetworkInterface.h.

Member Function Documentation

virtual nsapi_error_t add_dns_server ( const SocketAddress address,
const char *  interface_name 
)
virtualinherited

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

Parameters
addressAddress for the dns host.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

void add_event_listener ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
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.

Parameters
status_cbThe callback for status changes.
virtual void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
pure virtual

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_cbThe callback for status changes.

Reimplemented from NetworkInterface.

Implemented in AT_CellularContext.

virtual nsapi_error_t attach_to_network ( )
pure virtual

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

Implemented in AT_CellularContext.

virtual void cellular_callback ( nsapi_event_t  ev,
intptr_t  ptr 
)
protectedpure virtual

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

Parameters
evevent type
ptrevent-type dependent reason parameter

Implemented in AT_CellularContext.

virtual nsapi_error_t connect ( )
pure virtual

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.

Implemented in AT_CellularContext.

virtual nsapi_error_t connect ( const char *  sim_pin,
const char *  apn = 0,
const char *  uname = 0,
const char *  pwd = 0 
)
pure virtual

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

Parameters
sim_pinPIN for the SIM card.
apnAccess point name (optional).
unameUsername (optional).
pwdPassword (optional).
Returns
NSAPI_ERROR_OK on success, or negative error code on failure.

Implements CellularInterface.

Implemented in AT_CellularContext.

void cp_data_received ( )
protected

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

virtual nsapi_error_t disconnect ( )
pure virtual

Stop the interface.

Returns
NSAPI_ERROR_OK on success, or error code on failure.

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual EMACInterface* emacInterface ( )
virtualinherited

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

virtual void enable_hup ( bool  enable)
protectedpure virtual

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.

Implemented in AT_CellularContext.

virtual EthInterface* ethInterface ( )
virtualinherited

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

virtual nsapi_error_t get_apn_backoff_timer ( int &  backoff_timer)
pure virtual

Get backoff timer value.

Parameters
backoff_timerBackoff 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

Implemented in AT_CellularContext.

virtual nsapi_connection_status_t get_connection_status ( ) const
virtualinherited

Get the connection status.

Returns
The connection status (
See also
nsapi_types.h).

Reimplemented in EMACInterface, L3IPInterface, InterfaceNanostack, and AT_CellularContext.

virtual ControlPlane_netif* get_cp_netif ( )
pure virtual

Returns the control plane AT command interface.

Implemented in AT_CellularContext.

static CellularContext* get_default_instance ( )
static

Same as NetworkInterface::get_default_instance()

Note
not to be used if get_default_nonip_instance() was already used
static CellularContext* get_default_nonip_instance ( )
static

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
virtual const char* get_gateway ( )
pure virtual

Get the local gateways.

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

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual char* get_interface_name ( char *  interface_name)
virtualinherited

Get the network interface name.

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

Reimplemented in EMACInterface, and L3IPInterface.

virtual const char* get_ip_address ( )
pure virtual

Get the local IP address.

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

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual const char* get_mac_address ( )
virtualinherited

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.

virtual const char* get_netmask ( )
pure virtual

Get the local network mask.

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

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual nsapi_error_t get_pdpcontext_params ( pdpContextList_t params_list)
pure virtual

Get the relevant information for an active nonsecondary PDP context.

Remarks
optional params are not updated if not received from network.
Parameters
params_listreference 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

Implemented in AT_CellularContext.

virtual nsapi_error_t get_rate_control ( CellularContext::RateControlExceptionReports &  reports,
CellularContext::RateControlUplinkTimeUnit &  time_unit,
int &  uplink_rate 
)
pure virtual

Get APN rate control.

Remarks
optional params are not updated if not received from network, so use good defaults
Parameters
reportsAdditional exception reports at maximum rate reached are allowed to be sent [optional]
time_unitUplink time unit with values 0=unrestricted, 1=minute, 2=hour, 3=day, 4=week [optional]
uplink_rateMaximum number of messages per timeUnit [optional]
Returns
NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on case of failure

Implemented in AT_CellularContext.

virtual nsapi_error_t gethostbyname ( const char *  host,
SocketAddress address,
nsapi_version_t  version = NSAPI_UNSPEC,
const char *  interface_name = NULL 
)
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.

Parameters
hostHostname to resolve.
addressPointer to a SocketAddress to store the result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork interface name
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

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

Parameters
hostHostname to resolve.
callbackCallback that is called for result.
versionIP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC).
interface_nameNetwork 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.

virtual nsapi_error_t gethostbyname_async_cancel ( int  id)
virtualinherited

Cancel asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters
idUnique id of the hostname translation operation (returned by gethostbyname_async)
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

virtual bool is_connected ( )
pure virtual

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.

Implemented in AT_CellularContext.

virtual MeshInterface* meshInterface ( )
virtualinherited

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

virtual nsapi_error_t register_to_network ( )
pure virtual

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

Implemented in AT_CellularContext.

void remove_event_listener ( mbed::Callback< void(nsapi_event_t, intptr_t)>  status_cb)
inherited

Remove event listener from interface.

Remove previously added callback from the handler list.

Parameters
status_cbThe callback to unregister.
virtual void set_as_default ( )
virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, and L3IPInterface.

virtual nsapi_error_t set_blocking ( bool  blocking)
pure 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.

Parameters
blockingUse true 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.

Implemented in AT_CellularContext.

virtual void set_credentials ( const char *  apn,
const char *  uname = 0,
const char *  pwd = 0 
)
pure virtual

Set the cellular network credentials.

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

Parameters
apnAccess point name.
unameUsername (optional).
pwdPassword (optional).

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual nsapi_error_t set_device_ready ( )
pure virtual

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

Implemented in AT_CellularContext.

virtual nsapi_error_t set_dhcp ( bool  dhcp)
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.

Parameters
dhcpTrue to enable DHCP.
Returns
NSAPI_ERROR_OK on success, negative error code on failure.

Reimplemented in EMACInterface, and L3IPInterface.

virtual void set_file_handle ( FileHandle fh)
pure virtual

Set the file handle used to communicate with the modem.

You can use this to change the default file handle.

Parameters
fhfile handle for communicating with the modem

Implemented in AT_CellularContext.

virtual void set_file_handle ( UARTSerial serial,
PinName  dcd_pin = NC,
bool  active_high = false 
)
pure virtual

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
serialUARTSerial used in communication to modem. If null then the default file handle is used.
dcd_pinPin used to set data carrier detect on/off for the given UART
active_higha boolean set to true if DCD polarity is active low

Implemented in AT_CellularContext.

virtual nsapi_error_t set_network ( const char *  ip_address,
const char *  netmask,
const char *  gateway 
)
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.

Parameters
ip_addressNull-terminated representation of the local IP address
netmaskNull-terminated representation of the local network mask
gatewayNull-terminated representation of the local gateway
Returns
NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface, and L3IPInterface.

virtual void set_plmn ( const char *  plmn)
pure virtual

Set the plmn.

PLMN controls to what network device registers.

Parameters
plmnuser to force what network to register.

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual void set_sim_pin ( const char *  sim_pin)
pure virtual

Set the PIN code for SIM card.

Parameters
sim_pinPIN for the SIM card.

Implements CellularInterface.

Implemented in AT_CellularContext.

virtual nsapi_error_t set_sim_ready ( )
pure virtual

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

Implemented in AT_CellularContext.

virtual WiFiInterface* wifiInterface ( )
virtualinherited

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

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.