FreeRTOS: FreeRTOS Cellular Library v1.2.0
FreeRTOS Cellular Library
Cellular_common Function pointer types

Function pointer types of the cellular_common library. More...

Typedefs

typedef void(* CellularAtParseTokenHandler_t) (CellularContext_t *pContext, char *pInputStr)
 URC handler function. More...
 
typedef CellularPktStatus_t(* CellularATCommandDataPrefixCallback_t) (void *pCallbackContext, char *pLine, uint32_t lineLength, char **pDataStart, uint32_t *pDataLength)
 Callback used to inform pktio the data start and the length of the data. More...
 
typedef CellularPktStatus_t(* CellularATCommandDataSendPrefixCallback_t) (void *pCallbackContext, char *pLine, uint32_t *pBytesRead)
 Callback used to fix the stream before the send data. More...
 

Detailed Description

Function pointer types of the cellular_common library.

Typedef Documentation

◆ CellularAtParseTokenHandler_t

typedef void(* CellularAtParseTokenHandler_t) (CellularContext_t *pContext, char *pInputStr)

URC handler function.

Returns
Void.

◆ CellularATCommandDataPrefixCallback_t

typedef CellularPktStatus_t(* CellularATCommandDataPrefixCallback_t) (void *pCallbackContext, char *pLine, uint32_t lineLength, char **pDataStart, uint32_t *pDataLength)

Callback used to inform pktio the data start and the length of the data.

Parameters
[in]pCallbackContextThe pCallbackContext in _Cellular_TimeoutAtcmdDataRecvRequestWithCallback.
[in]pLineThe input line form cellular modem.
[in]lineLengthThe length of the input line from cellular modem.
[out]pDataStartIs the start of of data in pLine.
[out]pDataLengthIs the data length.
Returns
CELLULAR_PKT_STATUS_OK if the operation is successful. CELLULAR_PKT_STATUS_SIZE_MISMATCH if more data is required. Otherwise an error code indicating the cause of the error.

◆ CellularATCommandDataSendPrefixCallback_t

typedef CellularPktStatus_t(* CellularATCommandDataSendPrefixCallback_t) (void *pCallbackContext, char *pLine, uint32_t *pBytesRead)

Callback used to fix the stream before the send data.

Parameters
[in]pCallbackContextThe pCallbackContext in CellularATCommandDataSendPrefixCallback_t.
[in,out]pLineThe input line form cellular modem.
[in,out]pBytesReadThe length of the input line from cellular modem.
Returns
CELLULAR_PKT_STATUS_OK if the operation is successful, otherwise an error code indicating the cause of the error.