Inheritance diagram for AT_ControlPlane_netif:

Public Member Functions
ATHandler &	get_at_handler ()
	Getter for at handler. More...

device_err_t	get_device_error () const
	Gets the device error that happened when using AT commands/responses. More...

Static Public Member Functions
static void	set_cellular_properties (const intptr_t *property_array)
	Cellular module need to define an array of cellular properties which defines module supported property values. More...

static intptr_t	get_property (CellularProperty key)
	Get value for the given key. More...

Protected Member Functions
virtual nsapi_size_or_error_t	send (const void *cpdata, nsapi_size_t cpdata_length)
	Send data over cellular control plane. More...

virtual nsapi_size_or_error_t	recv (void *cpdata, nsapi_size_t cpdata_length)
	Receive data over cellular control plane. More...

virtual void	data_received ()
	Receives data from the control plane PDP context. More...

virtual void	attach (void(callback)(void ), void *data)
	Register a callback on state change of the socket. More...

Detailed Description

Definition at line 7 of file AT_ControlPlane_netif.h.

Member Function Documentation

virtual void attach	(	void()(void )	callback,
		void *	data
	)

protectedvirtual

Register a callback on state change of the socket.

The specified callback will be called on state changes such as when the socket can recv/send successfully and on when an error occurs. The callback may also be called spuriously without reason.

The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.

Parameters

callback	Function to call on state change
data	Argument to pass to callback

Implements ControlPlane_netif.

virtual void data_received ( )

protectedvirtual

Receives data from the control plane PDP context.

This function is called by cellular PDP context when data is received from network. It will invoke the callback set by the above attach.

Implements ControlPlane_netif.

ATHandler& get_at_handler ( )

inherited

Getter for at handler.

Common method for all AT-classes.

Returns: reference to ATHandler

device_err_t get_device_error ( ) const

inherited

Gets the device error that happened when using AT commands/responses.

This is at error returned by the device. Returned CME/CMS errors can be found from 3gpp documents 27007 and 27005.

Returns: at error (CME/CMS) while communicating with the device

static intptr_t get_property ( CellularProperty key )

staticinherited

Get value for the given key.

Parameters

key	key for value to be fetched

Returns: property value for the given key. Value type is defined in enum CellularProperty

virtual nsapi_size_or_error_t recv	(	void *	cpdata,
		nsapi_size_t	cpdata_length
	)

protectedvirtual

Receive data over cellular control plane.

Parameters

cpdata	Destination buffer for data received from control plane connection
cpdata_length	Length of data in bytes

Returns: Number of received bytes on success, negative error code on failure.

Implements ControlPlane_netif.

virtual nsapi_size_or_error_t send	(	const void *	cpdata,
		nsapi_size_t	cpdata_length
	)

protectedvirtual

Send data over cellular control plane.

Parameters

cpdata	Buffer of data to be sent over control plane connection
cpdata_length	Length of data in bytes

Returns: Number of sent bytes on success, negative error code on failure.

Implements ControlPlane_netif.

static void set_cellular_properties ( const intptr_t * property_array )

staticinherited

Cellular module need to define an array of cellular properties which defines module supported property values.

Parameters

property_array array of module properties

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

Important Information for this Arm website