rbCallbacks_t Struct Reference

Struct containing user defined callback functions for asynchronous operations. More...

#include <rockblock_9704.h>

Public Attributes
void(*	messageProvisioning )(const jsprMessageProvisioning_t *messageProvisioning)
	Callback for message provisioning info once its been obtained.
void(*	moMessageComplete )(const uint16_t id, const rbMsgStatus_t status)
	Callback for when a mobile-originated (MO) message has finished processing and been sent successfully.
void(*	mtMessageComplete )(const uint16_t id, const rbMsgStatus_t status)
	Callback for when a mobile-terminated (MT) message has finished processing and been received successfully.
void(*	constellationState )(const jsprConstellationState_t *state)
	Callback for the constellationState (signal) has been updated.
void(*	moMessageStarted )(const uint16_t id)
	Callback for when a mobile-originated (MO) message request has been accepted by the modem.
void(*	messageActivityStatus )(const bool active)
	Callback for when the messaging activity status has changed.

Detailed Description

Struct containing user defined callback functions for asynchronous operations.

This structure allows the user to register custom handlers that this library will invoke during specific events.

Member Data Documentation

constellationState

void(* rbCallbacks_t::constellationState) (const jsprConstellationState_t *state)

Callback for the constellationState (signal) has been updated.

Parameters

state

Pointer to the updated constellation state structure.

messageActivityStatus

void(* rbCallbacks_t::messageActivityStatus) (const bool active)

Callback for when the messaging activity status has changed.

Only called once notifications have been enabled with rbSetMessageActivityStatus(true).

Parameters

active

True when the modem has MO or MT messages to transfer and is, or intends to be, sending/receiving them. False when no message transfer is ongoing or required.

messageProvisioning

void(* rbCallbacks_t::messageProvisioning) (const jsprMessageProvisioning_t *messageProvisioning)

Callback for message provisioning info once its been obtained.

Parameters

messageProvisioning

Pointer to the provisioning info structure.

moMessageComplete

void(* rbCallbacks_t::moMessageComplete) (const uint16_t id, const rbMsgStatus_t status)

Callback for when a mobile-originated (MO) message has finished processing and been sent successfully.

Parameters

id	Unique Identifier of the message.
status	Enum indicating result of processing (-1 for failure & 1 for success).

moMessageStarted

void(* rbCallbacks_t::moMessageStarted) (const uint16_t id)

Callback for when a mobile-originated (MO) message request has been accepted by the modem.

Parameters

id	Unique Identifier of the message.

mtMessageComplete

void(* rbCallbacks_t::mtMessageComplete) (const uint16_t id, const rbMsgStatus_t status)

Callback for when a mobile-terminated (MT) message has finished processing and been received successfully.

Parameters

id	Unique Identifier of the message.
status	Enum indicating result of processing (-1 for failure & 1 for success).

---

The documentation for this struct was generated from the following file:

• rockblock_9704.h