ControlPlane_netif Class Reference

Implements support for data transfer using Control Plane CIoT EPS optimization specified in 3GPP 23.401(4.10), 3GPP 23.682(4.5.14). More...

#include <ControlPlane_netif.h>

Inheritance diagram for ControlPlane_netif:

Protected Member Functions
virtual nsapi_size_or_error_t	send (const void *cpdata, nsapi_size_t cpdata_length)=0
	Send data over cellular control plane. More...
virtual nsapi_size_or_error_t	recv (void *cpdata, nsapi_size_t cpdata_length)=0
	Receive data over cellular control plane. More...
virtual void	data_received ()=0
	Receives data from the control plane PDP context. More...
virtual void	attach (void(*callback)(void *), void *data)=0
	Register a callback on state change of the socket. More...

Detailed Description

Implements support for data transfer using Control Plane CIoT EPS optimization specified in 3GPP 23.401(4.10), 3GPP 23.682(4.5.14).

Definition at line 43 of file ControlPlane_netif.h.

Member Function Documentation

send()

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

protectedpure virtual

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.

Implemented in AT_ControlPlane_netif.

recv()

virtual nsapi_size_or_error_t recv ( void *  cpdata, nsapi_size_t  cpdata_length  )

protectedpure virtual

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.

Implemented in AT_ControlPlane_netif.

data_received()

virtual void data_received ( )

protectedpure virtual

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.

Implemented in AT_ControlPlane_netif.

attach()

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

protectedpure virtual

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

Implemented in AT_ControlPlane_netif.