RockBLOCK 9704 C Library
Doxygen documentation for the RockBLOCK 9704 C Library.
Loading...
Searching...
No Matches
Public Attributes | List of all members
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.
 

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
statePointer to the updated constellation state structure.

◆ messageProvisioning

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

Callback for message provisioning info once its been obtained.

Parameters
messageProvisioningPointer 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
idUnique Identifier of the message.
statusEnum indicating result of processing (-1 for failure & 1 for success).

◆ 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
idUnique Identifier of the message.
statusEnum indicating result of processing (-1 for failure & 1 for success).

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