Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

ControlPlane_netif Class Reference

ControlPlane_netif Class Reference
[Cellular]

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>

Inherited by AT_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.
virtual nsapi_size_or_error_t recv (void *cpdata, nsapi_size_t cpdata_length)=0
 Receive data over cellular control plane.
virtual void data_received ()=0
 Receives data from the control plane PDP context.
virtual void attach (void(*callback)(void *), void *data)=0
 Register a callback on state change of the socket.

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

virtual void attach ( void(*)(void *)  callback,
void *  data 
) [protected, pure 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:
callbackFunction to call on state change
dataArgument to pass to callback
virtual void data_received (  ) [protected, pure 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.

virtual nsapi_size_or_error_t recv ( void *  cpdata,
nsapi_size_t  cpdata_length 
) [protected, pure virtual]

Receive data over cellular control plane.

Parameters:
cpdataDestination buffer for data received from control plane connection
cpdata_lengthLength of data in bytes
Returns:
Number of received bytes on success, negative error code on failure.
virtual nsapi_size_or_error_t send ( const void *  cpdata,
nsapi_size_t  cpdata_length 
) [protected, pure virtual]

Send data over cellular control plane.

Parameters:
cpdataBuffer of data to be sent over control plane connection
cpdata_lengthLength of data in bytes
Returns:
Number of sent bytes on success, negative error code on failure.