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

#include <CellularContext.h>

Inheritance diagram for CellularContext:

Data Structures
struct	pdpcontext_params_t
	PDP Context information. More...

Public Types
typedef mbed::Callback< void(nsapi_value_or_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 nsapi_error_t	get_ip_address (SocketAddress *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 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 &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 nsapi_error_t	configure_hup (PinName dcd_pin=NC, bool active_high=false)=0
	Enable or disable hang-up detection. 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...

CellularInterface *	cellularInterface () final
	Return pointer to a CellularInterface. More...

void	set_default_parameters () override
	defined(DOXYGEN_ONLY) More...

virtual void	set_as_default ()
	Set network interface as default one. More...

virtual const char *	get_hostname ()
	Get hostname. More...

virtual nsapi_error_t	set_hostname (const char *hostname)
	Set hostname. More...

virtual const char *	get_mac_address ()
	Get the local MAC address. More...

virtual nsapi_error_t	set_mac_address (uint8_t *mac_addr, nsapi_size_t addr_len)
	Set the MAC address to the interface. More...

virtual nsapi_error_t	get_ipv6_link_local_address (SocketAddress *address)
	Get the IPv6 link local address. More...

virtual nsapi_error_t	get_netmask (SocketAddress *address)
	Get the local network mask. More...

virtual nsapi_error_t	get_gateway (SocketAddress *address)
	Get the local gateway. More...

virtual char *	get_interface_name (char *interface_name)
	Get the network interface name. More...

virtual nsapi_error_t	set_network (const SocketAddress &ip_address, const SocketAddress &netmask, const SocketAddress &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	getaddrinfo (const char hostname, SocketAddress hints, SocketAddress *res, const char interface_name=NULL)
	Translate a hostname to the multiple IP addresses 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_value_or_error_t	getaddrinfo_async (const char hostname, SocketAddress hints, hostbyname_cb_t callback, const char *interface_name=NULL)
	Translate a hostname to the multiple IP addresses (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...

virtual nsapi_error_t	get_dns_server (int index, SocketAddress address, const char interface_name=NULL)
	Get a domain name server from a 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...

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 const char *	get_nonip_context_type_str ()=0
	Return PDP type string for Non-IP if modem uses other than standard "Non-IP". 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::pdp_type_t	string_to_pdp_type (const char *pdp_type)
	Converts the given pdp type in char format to enum pdp_type_t. More...

Detailed Description

CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity.

Definition at line 45 of file CellularContext.h.

Member Typedef Documentation

◆ hostbyname_cb_t

typedef mbed::Callback<void (nsapi_value_or_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.

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

Member Function Documentation

◆ set_blocking()

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

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.

Implemented in AT_CellularContext.

◆ get_ip_address()

virtual nsapi_error_t get_ip_address ( SocketAddress * address )

pure virtual

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.

Implemented in AT_CellularContext.

◆ attach()

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

Reimplemented from NetworkInterface.

Implemented in AT_CellularContext.

◆ connect() [1/2]

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.

◆ disconnect()

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.

◆ set_plmn()

virtual void set_plmn ( const char * plmn )

pure virtual

Set the plmn.

PLMN controls to what network device registers.

Parameters

plmn	user to force what network to register.

Implements CellularInterface.

Implemented in AT_CellularContext.

◆ set_sim_pin()

virtual void set_sim_pin ( const char * sim_pin )

pure virtual

Set the PIN code for SIM card.

Parameters

sim_pin PIN for the SIM card.

Implements CellularInterface.

Implemented in AT_CellularContext.

◆ connect() [2/2]

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

Implemented in AT_CellularContext.

◆ set_credentials()

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

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

Implements CellularInterface.

Implemented in AT_CellularContext.

◆ is_connected()

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.

◆ get_default_instance()

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

◆ get_default_nonip_instance()

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

◆ get_device()

CellularDevice * get_device ( ) const

Get pointer to CellularDevice instance.

May be null if not AT-layer.

Returns: pointer to CellularDevice instance

◆ set_device_ready()

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.

◆ set_sim_ready()

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.

◆ register_to_network()

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.

◆ attach_to_network()

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.

◆ get_rate_control()

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

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

Implemented in AT_CellularContext.

◆ get_pdpcontext_params()

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

Implemented in AT_CellularContext.

◆ get_apn_backoff_timer()

virtual nsapi_error_t get_apn_backoff_timer ( int & backoff_timer )

pure virtual

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

Implemented in AT_CellularContext.

◆ configure_hup()

virtual nsapi_error_t configure_hup	(	PinName	dcd_pin = `NC`,
		bool	active_high = `false`
	)

pure virtual

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

Implemented in AT_CellularContext.

◆ get_cp_netif()

virtual ControlPlane_netif * get_cp_netif ( )

pure virtual

Returns the control plane AT command interface.

Implemented in AT_CellularContext.

◆ get_cid()

int get_cid ( ) const

Get the pdp context id associated with this context.

Returns: cid

◆ set_authentication_type()

void set_authentication_type ( AuthenticationType type )

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

Parameters

type	enum AuthenticationType

◆ cellular_callback()

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

ev	event type
ptr	event-type dependent reason parameter

Implemented in AT_CellularContext.

◆ get_nonip_context_type_str()

virtual const char * get_nonip_context_type_str ( )

protectedpure virtual

Return PDP type string for Non-IP if modem uses other than standard "Non-IP".

Some modems uses a non-standard PDP type string for non-ip (e.g. "NONIP"). In those cases modem driver must implement this method to return the PDP type string used by the modem.

Returns: PDP type string used by the modem or NULL if standard ("Non-IP")

Implemented in AT_CellularContext.

◆ cp_data_received()

void cp_data_received ( )

protected

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

◆ do_connect_with_retry()

virtual void do_connect_with_retry ( )

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.

◆ call_network_cb()

void call_network_cb ( nsapi_connection_status_t status )

protected

Helper method to call callback function if it is provided.

Parameters

status connection status which is parameter in callback function

◆ do_connect()

virtual void do_connect ( )

protectedvirtual

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

Reimplemented in AT_CellularContext.

◆ validate_ip_address()

void validate_ip_address ( )

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.

◆ string_to_pdp_type()

CellularContext::pdp_type_t string_to_pdp_type ( const char * pdp_type )

protected

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

◆ cellularInterface()

CellularInterface * cellularInterface ( )

finalvirtualinherited

Return pointer to a CellularInterface.

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

Reimplemented from NetworkInterface.

Definition at line 103 of file CellularInterface.h.

◆ set_default_parameters()

void set_default_parameters ( )

overridevirtualinherited

defined(DOXYGEN_ONLY)

Set default parameters on a cellular interface.

A cellular interface instantiated directly or using CellularInterface::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 from NetworkInterface.

◆ set_as_default()

virtual void set_as_default ( )

virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

◆ get_hostname()

virtual const char * get_hostname ( )

virtualinherited

Get hostname.

Returns: Hostname if configured, null otherwise

Reimplemented in EMACInterface.

◆ set_hostname()

virtual nsapi_error_t set_hostname ( const char * hostname )

virtualinherited

Set hostname.

Parameters

hostname Hostname string

Return values

NSAPI_ERROR_OK	on success
NSAPI_ERROR_UNSUPPORTED	if this feature is not supported
NSAPI_ERROR_PARAMETER	if hostname is not valid
NSAPI_ERROR_BUSY	if hostname couldn't be set (e.g. for LwIP stack, hostname can only be set before calling `EthernetInterface::connect` method)

Reimplemented in EMACInterface.

◆ get_mac_address()

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.

◆ set_mac_address()

virtual nsapi_error_t set_mac_address	(	uint8_t *	mac_addr,
		nsapi_size_t	addr_len
	)

virtualinherited

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.

◆ get_ipv6_link_local_address()

virtual nsapi_error_t get_ipv6_link_local_address ( SocketAddress * address )

virtualinherited

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

virtual nsapi_error_t get_netmask ( SocketAddress * address )

virtualinherited

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

virtual nsapi_error_t get_gateway ( SocketAddress * address )

virtualinherited

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

◆ get_interface_name()

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 AT_CellularContext, EMACInterface, L3IPInterface, and PPPInterface.

◆ set_network()

virtual nsapi_error_t set_network	(	const SocketAddress &	ip_address,
		const SocketAddress &	netmask,
		const SocketAddress &	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_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_dhcp()

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

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.

◆ gethostbyname()

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

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.

◆ getaddrinfo()

virtual nsapi_value_or_error_t getaddrinfo	(	const char *	hostname,
		SocketAddress *	hints,
		SocketAddress **	res,
		const char *	interface_name = `NULL`
	)

virtualinherited

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.

◆ gethostbyname_async()

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

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.

◆ getaddrinfo_async()

virtual nsapi_value_or_error_t getaddrinfo_async	(	const char *	hostname,
		SocketAddress *	hints,
		hostbyname_cb_t	callback,
		const char *	interface_name = `NULL`
	)

virtualinherited

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.

◆ gethostbyname_async_cancel()

virtual nsapi_error_t gethostbyname_async_cancel ( int id )

virtualinherited

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.

◆ add_dns_server()

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

address	Address for the dns host.
interface_name	Network interface name. Currently unused, the server is added for all interfaces.

Returns: NSAPI_ERROR_OK on success, negative error code on failure.

Implements DNS.

◆ get_dns_server()

virtual nsapi_error_t get_dns_server	(	int	index,
		SocketAddress *	address,
		const char *	interface_name = `NULL`
	)

virtualinherited

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

◆ add_event_listener()

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.

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.

◆ get_connection_status()

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 AT_CellularContext, InterfaceNanostack, EMACInterface, L3IPInterface, and PPPInterface.

◆ ethInterface()

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

◆ wifiInterface()

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

◆ meshInterface()

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

◆ emacInterface()

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

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ hostbyname_cb_t

Member Function Documentation

◆ set_blocking()

◆ get_ip_address()

◆ attach()

◆ connect() [1/2]

◆ disconnect()

◆ set_plmn()

◆ set_sim_pin()

◆ connect() [2/2]

◆ set_credentials()

◆ is_connected()

◆ get_default_instance()

◆ get_default_nonip_instance()

◆ get_device()

◆ set_device_ready()

◆ set_sim_ready()

◆ register_to_network()

◆ attach_to_network()

◆ get_rate_control()

◆ get_pdpcontext_params()

◆ get_apn_backoff_timer()

◆ configure_hup()

◆ get_cp_netif()

◆ get_cid()

◆ set_authentication_type()

◆ cellular_callback()

◆ get_nonip_context_type_str()

◆ cp_data_received()

◆ do_connect_with_retry()

◆ call_network_cb()

◆ do_connect()

◆ validate_ip_address()

◆ string_to_pdp_type()

◆ cellularInterface()

◆ set_default_parameters()

◆ set_as_default()

◆ get_hostname()

◆ set_hostname()

◆ get_mac_address()

◆ set_mac_address()

◆ get_ipv6_link_local_address()

◆ get_netmask()

◆ get_gateway()

◆ get_interface_name()

◆ set_network()

◆ set_dhcp()

◆ gethostbyname()

◆ getaddrinfo()

◆ gethostbyname_async()

◆ getaddrinfo_async()

◆ gethostbyname_async_cancel()

◆ add_dns_server()

◆ get_dns_server()

◆ add_event_listener()

◆ get_connection_status()

◆ ethInterface()

◆ wifiInterface()

◆ meshInterface()

◆ emacInterface()