Myriota Flex SDK 2.5.0
Loading...
Searching...
No Matches
User Messages

Build and schedule messages for satellite transmission. More...

Functions

int FLEX_MessageSchedule (const uint8_t *const Message, const size_t MessageSize)
 
int FLEX_MessageSlotsFree (void)
 
size_t FLEX_MessageBytesFree (void)
 
void FLEX_MessageSave (void)
 
void FLEX_MessageQueueClear (void)
 Clear all messages in the message queue.
 

Detailed Description

Build and schedule messages for satellite transmission.

Function Documentation

◆ FLEX_MessageSchedule()

int FLEX_MessageSchedule ( const uint8_t *const Message,
const size_t MessageSize )

Calling ScheduleMessage when the number of slots returned by MessageSlotsFree is 0 and replaces an existing message in the queue. This may result in dropped messages.

Parameters
[in]Messagepointer to the message to be scheduled.
[in]MessageSizelength of the message.
Returns
FLEX_SUCCESS (0) if succeeded and < 0 if failed.

◆ FLEX_MessageSlotsFree()

int FLEX_MessageSlotsFree ( void )

Returns the number of available slots in the internal message queue, that is, the number of messages that can be scheduled with FLEX_MessageSchedule

◆ FLEX_MessageBytesFree()

size_t FLEX_MessageBytesFree ( void )

Returns the number of bytes remaining in the internal queue, that is, the number of bytes that can be scheduled with FLEX_MessageSchedule

Returns
number of bytes remaining in the internal queue.

◆ FLEX_MessageSave()

void FLEX_MessageSave ( void )

Save all messages in the message queue to the module's persistent storage. Saved messages will be transmitted after reset.