CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity. More...
#include <CellularContext.h>
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... | |
CellularDevice * | get_device () const |
Get pointer to CellularDevice instance. 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 ¶ms_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_netif * | get_cp_netif ()=0 |
Returns the control plane AT command interface. More... | |
int | get_cid () const |
Get the pdp context id associated with this context. More... | |
void | set_authentication_type (AuthenticationType type) |
Set the authentication type to be used in user authentication if user name and password are defined. More... | |
virtual CellularInterface * | cellularBase () |
Return pointer to a CellularInterface. More... | |
virtual CellularInterface * | cellularInterface () |
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 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 EMACInterface * | emacInterface () |
Return pointer to an EMACInterface. More... | |
Static Public Member Functions | |
static CellularContext * | get_default_instance () |
Same as NetworkInterface::get_default_instance() More... | |
static CellularContext * | get_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... | |
virtual void | do_connect_with_retry () |
Retry logic after device attached to network. More... | |
void | call_network_cb (nsapi_connection_status_t status) |
Helper method to call callback function if it is provided. More... | |
virtual void | do_connect () |
Find and activate pdp context or in case of PPP find correct pdp context and open data channel. More... | |
void | validate_ip_address () |
After we have connected successfully we must check that we have a valid IP address. More... | |
CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity.
Definition at line 39 of file CellularContext.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. |
|
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.
status_cb | The callback for status changes. |
Reimplemented from NetworkInterface.
Implemented in AT_CellularContext.
|
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(...)
Implemented in AT_CellularContext.
|
protected |
Helper method to call callback function if it is provided.
status | connection status which is parameter in callback function |
|
protectedpure virtual |
The CellularDevice calls the status callback function on status changes on the network or CellularDevice.
ev | event type |
ptr | event-type dependent reason parameter |
Implemented in AT_CellularContext.
|
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.
Implements CellularInterface.
Implemented in AT_CellularContext.
|
pure virtual |
Attempt to connect to a cellular network with a PIN and credentials.
sim_pin | PIN for the SIM card. |
apn | Access point name (optional). |
uname | Username (optional). |
pwd | Password (optional). |
Implements CellularInterface.
Implemented in AT_CellularContext.
|
protected |
Triggers control plane's operations needed when control plane data is received, like socket event, for example.
|
pure virtual |
Stop the interface.
Implements CellularInterface.
Implemented in AT_CellularContext.
|
protectedvirtual |
Find and activate pdp context or in case of PPP find correct pdp context and open data channel.
Reimplemented in AT_CellularContext.
|
protectedvirtual |
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.
|
virtualinherited |
Return pointer to an EMACInterface.
Reimplemented in EMACInterface.
Definition at line 355 of file NetworkInterface.h.
|
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.
|
virtualinherited |
Return pointer to an EthInterface.
Reimplemented in EthInterface.
Definition at line 321 of file NetworkInterface.h.
|
pure virtual |
Get backoff timer value.
backoff_timer | Backoff timer value associated with PDP APN in seconds |
Implemented in AT_CellularContext.
int get_cid | ( | ) | const |
Get the pdp context id associated with this context.
|
virtualinherited |
Get the connection status.
Reimplemented in EMACInterface, L3IPInterface, InterfaceNanostack, PPPInterface, and AT_CellularContext.
|
pure virtual |
Returns the control plane AT command interface.
Implemented in AT_CellularContext.
|
static |
Same as NetworkInterface::get_default_instance()
|
static |
Instantiates a default Non-IP cellular interface.
This function creates a new Non-IP PDP context.
CellularDevice* get_device | ( | ) | const |
Get pointer to CellularDevice instance.
May be null if not AT-layer.
|
pure virtual |
Get the local gateways.
Implements CellularInterface.
Implemented in AT_CellularContext.
|
virtualinherited |
Get the network interface name.
Reimplemented in EMACInterface, L3IPInterface, PPPInterface, and AT_CellularContext.
|
pure virtual |
Get the local IP address.
Implements CellularInterface.
Implemented in AT_CellularContext.
|
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.
Reimplemented in InterfaceNanostack, and EMACInterface.
|
pure virtual |
Get the local network mask.
Implements CellularInterface.
Implemented in AT_CellularContext.
|
pure virtual |
Get the relevant information for an active nonsecondary PDP context.
params_list | reference to linked list, which is filled on successful call |
Implemented in AT_CellularContext.
|
pure virtual |
Get APN rate control.
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] |
Implemented in 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.
|
pure virtual |
Check if the connection is currently established.
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.
|
virtualinherited |
Return pointer to a MeshInterface.
Reimplemented in MeshInterface.
Definition at line 337 of file NetworkInterface.h.
|
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(...)
Implemented in AT_CellularContext.
|
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.
void set_authentication_type | ( | AuthenticationType | type | ) |
Set the authentication type to be used in user authentication if user name and password are defined.
type | enum AuthenticationType |
|
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.
blocking | Use false to set NetworkInterface in asynchronous mode. |
Reimplemented from NetworkInterface.
Implemented in AT_CellularContext.
|
pure virtual |
Set the cellular network credentials.
Please check documentation of connect() for default behavior of APN settings.
apn | Access point name. |
uname | Username (optional). |
pwd | Password (optional). |
Implements CellularInterface.
Implemented in AT_CellularContext.
|
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(...)
Implemented in AT_CellularContext.
|
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.
|
pure virtual |
Set the file handle used to communicate with the modem.
You can use this to change the default file handle.
fh | file handle for communicating with the modem |
Implemented in AT_CellularContext.
|
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.
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 |
Implemented in AT_CellularContext.
|
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.
|
pure virtual |
Set the plmn.
PLMN controls to what network device registers.
plmn | user to force what network to register. |
Implements CellularInterface.
Implemented in AT_CellularContext.
|
pure virtual |
Set the PIN code for SIM card.
sim_pin | PIN for the SIM card. |
Implements CellularInterface.
Implemented in AT_CellularContext.
|
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(...)
Implemented in AT_CellularContext.
|
protected |
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.
|
virtualinherited |
Return pointer to a WiFiInterface.
Reimplemented in WiFiInterface.
Definition at line 329 of file NetworkInterface.h.