imt_queue.c File Reference

#include "imt_queue.h"

Functions
bool	imtQueueMoAdd (uint16_t topic, const char *data, const size_t length)
	Add an outgoing mobile-originated (MO) message to the queue. More...
bool	imtQueueMtAdd (const uint16_t topic, const uint16_t id, const size_t length)
	Add an incoming mobile-terminated (MT) message to the queue. More...
void	imtQueueMtLock (bool lock)
	Lock or unlock the MT queue to prevent messages from getting discarded if full. More...
void	imtQueueMoLock (bool lock)
	Lock or unlock the MO queue to prevent messages from getting discarded if full. More...
imt_t *	imtQueueMoGetFirst (void)
	Get the address of the head of the MO queue. More...
imt_t *	imtQueueMtGetFirst (void)
	Get the address of the head of the MT queue. More...
imt_t *	imtQueueMtGetLast (void)
	Get the address of the latest message in the MT queue. More...
bool	imtQueueMoRemove (void)
	Remove an outgoing mobile-originated (MO) message from the queue. More...
bool	imtQueueMtRemove (void)
	Remove an outgoing mobile-terminated (MT) message from the queue. More...
void	imtQueueInit (void)
	Used to initialise both outgoing and incoming queues. More...

Variables
static imt_queue_t	imtMo
static imt_queue_t	imtMt
static uint8_t	imtMoBuffer [1U][100000U+2U]
static uint8_t	imtMtBuffer [1U][100000U+2U]
static volatile bool	mtLock = false
static volatile bool	moLock = true
uint16_t	moQueuedMessages

Function Documentation

imtQueueInit()

void imtQueueInit

(

void

)

Used to initialise both outgoing and incoming queues.

imtQueueMoAdd()

bool imtQueueMoAdd	(	const uint16_t	topic,
		const char *	data,
		const size_t	length
	)

Add an outgoing mobile-originated (MO) message to the queue.

Parameters

topic	Message topic ID.
data	Pointer to the message payload.
length	Message payload length in bytes.

Returns

Bool indicating success or failure to add the message to the queue.

imtQueueMoGetFirst()

imt_t* imtQueueMoGetFirst

(

void

)

Get the address of the head of the MO queue.

Returns

Pointer to the next message in the queue, NULL if queue is empty.

imtQueueMoLock()

void imtQueueMoLock

(

bool

lock

)

Lock or unlock the MO queue to prevent messages from getting discarded if full.

Parameters

lock	Called with true to lock the queue and false to unlock the queue.

Note

This is set to false by default.

imtQueueMoRemove()

bool imtQueueMoRemove

(

void

)

Remove an outgoing mobile-originated (MO) message from the queue.

Returns

Bool indicating success or failure to remove the message from the queue.

imtQueueMtAdd()

bool imtQueueMtAdd	(	const uint16_t	topic,
		const uint16_t	id,
		const size_t	length
	)

Add an incoming mobile-terminated (MT) message to the queue.

Parameters

topic	Message topic ID.
id	Unique identifier of the message assigned by the modem.
length	Message payload length in bytes.

Returns

Bool indicating success or failure to add the message to the queue.

imtQueueMtGetFirst()

imt_t* imtQueueMtGetFirst

(

void

)

Get the address of the head of the MT queue.

Returns

Pointer to the next message in the queue, NULL if queue is empty.

imtQueueMtGetLast()

imt_t* imtQueueMtGetLast

(

void

)

Get the address of the latest message in the MT queue.

Returns

Pointer to the last message in the queue, NULL if queue is empty.

imtQueueMtLock()

void imtQueueMtLock

(

bool

lock

)

Lock or unlock the MT queue to prevent messages from getting discarded if full.

Parameters

lock	Called with true to lock the queue and false to unlock the queue.

Note

This is set to false by default.

imtQueueMtRemove()

bool imtQueueMtRemove

(

void

)

Remove an outgoing mobile-terminated (MT) message from the queue.

Returns

Bool indicating success or failure to remove the message from the queue.

Variable Documentation

imtMo

imt_queue_t imtMo

static

imtMoBuffer

uint8_t imtMoBuffer[1U][100000U+ 2U]

static

imtMt

imt_queue_t imtMt

static

imtMtBuffer

uint8_t imtMtBuffer[1U][100000U+ 2U]

static

moLock

volatile bool moLock = true

static

moQueuedMessages

uint16_t moQueuedMessages

extern

mtLock

volatile bool mtLock = false

static