Common interface that is shared between cellular interfaces. More...

#include <CellularInterface.h>

Inheritance diagram for CellularInterface:

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 void	set_credentials (const char apn, const char uname=0, const char *pwd=0)=0
	Set the cellular network credentials. 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 nsapi_error_t	connect ()=0
	Attempt to connect to a cellular network. More...

virtual nsapi_error_t	disconnect ()=0
	Stop the interface. More...

virtual bool	is_connected ()=0
	Check if the connection is currently established. More...

virtual nsapi_error_t	get_ip_address (SocketAddress *address)=0
	Get the local IP address. More...

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

virtual nsapi_error_t	get_gateway (SocketAddress *address)=0
	Get the local gateway. 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 nsapi_error_t	get_ipv6_link_local_address (SocketAddress *address)
	Get the IPv6 link local address. 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	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...

virtual void	attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
	Register callback for status reporting. 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 nsapi_error_t	set_blocking (bool blocking)
	Set asynchronous operation of connect() and disconnect() calls. 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 CellularInterface *	get_default_instance ()
	Get the default cellular interface. More...

Detailed Description

Common interface that is shared between cellular interfaces.

Definition at line 29 of file CellularInterface.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

result	NSAPI_ERROR_OK on success, negative error code on failure.
address	On success, destination for the host SocketAddress.

Definition at line 249 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

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

virtual void attach ( mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb )

virtualinherited

Register callback for status reporting.

The specified status callback function will be called on status changes on the network. The parameters on the callback are the event type and event-type dependent reason parameter. Only one callback can be registered at a time.

To unregister a callback call with status_cb parameter as a zero.

NOTE: Any callbacks registered with this function will be overwritten if add_event_listener() API is used.

Parameters

status_cb The callback for status changes.

Reimplemented in EMACInterface, CellularContext, InterfaceNanostack, L3IPInterface, PPPInterface, and 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 385 of file NetworkInterface.h.

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

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

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.

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

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

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.

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.

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

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_cb The callback to unregister.

virtual void set_as_default ( )

virtualinherited

Set network interface as default one.

Reimplemented in EMACInterface, L3IPInterface, and PPPInterface.

virtual nsapi_error_t set_blocking ( bool blocking )

virtualinherited

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 in EMACInterface, InterfaceNanostack, WhdSoftAPInterface, L3IPInterface, PPPInterface, WhdSTAInterface, CellularContext, and 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

dhcp	True to enable DHCP.

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

Reimplemented in EMACInterface, and L3IPInterface.

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

Returns: NSAPI_ERROR_OK on success, negative error code on failure

Reimplemented in EMACInterface.

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation

Important Information for this Arm website