Cellular Function pointer types

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

Typedefs
typedef CellularPktStatus_t(*	CellularATCommandResponseReceivedCallback_t) (CellularHandle_t cellularHandle, const CellularATCommandResponse_t *pAtResp, void *pData, uint16_t dataLen)
	Callback used to inform about the response of an AT command sent using Cellular_ATCommandRaw API.
typedef void(*	CellularUrcNetworkRegistrationCallback_t) (CellularUrcEvent_t urcEvent, const CellularServiceStatus_t *pServiceStatus, void *pCallbackContext)
	Callback used to inform about a Network Registration URC event.
typedef void(*	CellularUrcPdnEventCallback_t) (CellularUrcEvent_t urcEvent, uint8_t contextId, void *pCallbackContext)
	Callback used to inform about PDN URC events.
typedef void(*	CellularUrcSignalStrengthChangedCallback_t) (CellularUrcEvent_t urcEvent, const CellularSignalInfo_t *pSignalInfo, void *pCallbackContext)
	Callback used to inform about signal strength changed URC event.
typedef void(*	CellularUrcGenericCallback_t) (const char *pRawData, void *pCallbackContext)
	Generic callback used to inform all other URC events.
typedef void(*	CellularModemEventCallback_t) (CellularModemEvent_t modemEvent, void *pCallbackContext)
	Callback used to inform about modem events.
typedef void(*	CellularSocketOpenCallback_t) (CellularUrcEvent_t urcEvent, CellularSocketHandle_t socketHandle, void *pCallbackContext)
	Callback used to inform about the status of socket open.
typedef void(*	CellularSocketDataReadyCallback_t) (CellularSocketHandle_t socketHandle, void *pCallbackContext)
	Callback used to inform that data is ready for reading on a socket.
typedef void(*	CellularSocketClosedCallback_t) (CellularSocketHandle_t socketHandle, void *pCallbackContext)
	Callback used to inform that remote end closed the connection for a connected socket.

Detailed Description

Function pointer types of the cellular library.

Typedef Documentation

CellularATCommandResponseReceivedCallback_t

typedef CellularPktStatus_t(* CellularATCommandResponseReceivedCallback_t) (CellularHandle_t cellularHandle, const CellularATCommandResponse_t *pAtResp, void *pData, uint16_t dataLen)

Callback used to inform about the response of an AT command sent using Cellular_ATCommandRaw API.

Parameters

[in]	cellularHandle	The opaque cellular context pointer created by Cellular_Init.
[in]	pAtResp	The response received for the AT command.
[in]	pData	is pATCommandPayload pointer in Cellular_ATCommandRaw parameters.
[in]	dataLen	is the string length of pATCommandPayload in in Cellular_ATCommandRaw parameters.

Returns

CELLULAR_PKT_STATUS_OK if the operation is successful, otherwise an error code indicating the cause of the error.

CellularUrcNetworkRegistrationCallback_t

typedef void(* CellularUrcNetworkRegistrationCallback_t) (CellularUrcEvent_t urcEvent, const CellularServiceStatus_t *pServiceStatus, void *pCallbackContext)

Callback used to inform about a Network Registration URC event.

Parameters

[in]	urcEvent	URC Event that happened.
[in]	pServiceStatus	The status of the network service.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_RegisterUrcNetworkRegistrationEventCallback function.

CellularUrcPdnEventCallback_t

typedef void(* CellularUrcPdnEventCallback_t) (CellularUrcEvent_t urcEvent, uint8_t contextId, void *pCallbackContext)

Callback used to inform about PDN URC events.

Parameters

[in]	urcEvent	URC Event that happened.
[in]	contextId	Context ID of the PDN context
[in]	pCallbackContext	pCallbackContext parameter in Cellular_RegisterUrcPdnEventCallback function.

CellularUrcSignalStrengthChangedCallback_t

typedef void(* CellularUrcSignalStrengthChangedCallback_t) (CellularUrcEvent_t urcEvent, const CellularSignalInfo_t *pSignalInfo, void *pCallbackContext)

Callback used to inform about signal strength changed URC event.

Parameters

[in]	urcEvent	URC Event that happened.
[in]	pSignalInfo	The new signal information.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_RegisterUrcSignalStrengthChangedCallback function.

CellularUrcGenericCallback_t

typedef void(* CellularUrcGenericCallback_t) (const char *pRawData, void *pCallbackContext)

Generic callback used to inform all other URC events.

Parameters

[in]	pRawData	Raw data received in the URC event.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_RegisterUrcGenericCallback function.

CellularModemEventCallback_t

typedef void(* CellularModemEventCallback_t) (CellularModemEvent_t modemEvent, void *pCallbackContext)

Callback used to inform about modem events.

Parameters

[in]	modemEvent	The modem event.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_RegisterModemEventCallback function.

CellularSocketOpenCallback_t

typedef void(* CellularSocketOpenCallback_t) (CellularUrcEvent_t urcEvent, CellularSocketHandle_t socketHandle, void *pCallbackContext)

Callback used to inform about the status of socket open.

Parameters

[in]	urcEvent	URC Event that happened.
[in]	socketHandle	Socket handle for which data is ready.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_SocketRegisterSocketOpenCallback function.

CellularSocketDataReadyCallback_t

typedef void(* CellularSocketDataReadyCallback_t) (CellularSocketHandle_t socketHandle, void *pCallbackContext)

Callback used to inform that data is ready for reading on a socket.

Parameters

[in]	socketHandle	Socket handle for which data is ready.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_SocketRegisterDataReadyCallback function.

CellularSocketClosedCallback_t

typedef void(* CellularSocketClosedCallback_t) (CellularSocketHandle_t socketHandle, void *pCallbackContext)

Callback used to inform that remote end closed the connection for a connected socket.

Parameters

[in]	socketHandle	Socket handle for which remote end closed the connection.
[in]	pCallbackContext	pCallbackContext parameter in Cellular_SocketRegisterClosedCallback function.