Queue handling library (written in plain c) More...

#include <inttypes.h>
#include <stdbool.h>
#include <stddef.h>

Include dependency graph for cQueue.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	Queue_t
	Queue type structure holding all variables to handle the queue. More...

Macros
#define	q_init_def(q, sz) q_init(q, sz, 20, FIFO, false)
	Some kind of default behavior for queue initialization.

#define	q_pull q_pop

#define	q_nbRecs q_getCount

#define	q_clean q_flush

Typedefs
typedef enum enumQueueType	QueueType

typedef struct Queue_t	Queue_t

Enumerations
enum	enumQueueType { FIFO = 0 , LIFO = 1 }
	Queue behavior enumeration (FIFO, LIFO) More...

Functions
void *	q_init (Queue_t *const pQ, const size_t size_rec, const uint16_t nb_recs, const QueueType type, const bool overwrite)
	Queue initialization (using dynamic queue allocation)

void *	q_init_static (Queue_t const pQ, const size_t size_rec, const uint16_t nb_recs, const QueueType type, const bool overwrite, void const pQDat, const size_t lenQDat)
	Queue initialization (using static queue)

void	q_kill (Queue_t *const pQ)
	Queue destructor: release dynamically allocated queue.

void	q_flush (Queue_t *const pQ)
	Flush queue, restarting from empty queue.

bool	q_push (Queue_t const pQ, const void const record)
	Push record to queue.

bool	q_pop (Queue_t const pQ, void const record)
	Pop record from queue.

bool	q_peek (const Queue_t const pQ, void const record)
	Peek record from queue.

bool	q_drop (Queue_t *const pQ)
	Drop current record from queue.

bool	q_peekIdx (const Queue_t const pQ, void const record, const uint16_t idx)
	Peek record at index from queue.

bool	q_peekPrevious (const Queue_t const pQ, void const record)
	Peek previous record from queue.

bool	q_isInitialized (const Queue_t *const pQ)
	get initialization state of the queue

uint32_t	q_sizeof (const Queue_t *const pQ)
	get size of queue

bool	q_isEmpty (const Queue_t *const pQ)
	get emptiness state of the queue

bool	q_isFull (const Queue_t *const pQ)
	get fullness state of the queue

uint16_t	q_getCount (const Queue_t *const pQ)
	get number of records in the queue

uint16_t	q_getRemainingCount (const Queue_t *const pQ)
	get number of records left in the queue

Detailed Description

Queue handling library (written in plain c)

Author: SMFSW

Copyright: BSD 3-Clause License (c) 2017-2024, SMFSW

Queue handling library (written in plain c)

Macro Definition Documentation

◆ q_clean

#define q_clean q_flush

Deprecated: q_clean was already used in cQueue lib, alias is made to keep compatibility with earlier versions

◆ q_init_def

#define q_init_def	(		q,
			sz ) q_init(q, sz, 20, FIFO, false)

Some kind of default behavior for queue initialization.

◆ q_nbRecs

#define q_nbRecs q_getCount

Deprecated: q_nbRecs was already used in cQueue lib, alias is made to keep compatibility with earlier versions

◆ q_pull

#define q_pull q_pop

Deprecated: q_pull was already used in cQueue lib, alias is made to keep compatibility with earlier versions

Typedef Documentation

◆ Queue_t

typedef struct Queue_t Queue_t

◆ QueueType

typedef enum enumQueueType QueueType

Enumeration Type Documentation

◆ enumQueueType

enum enumQueueType

Queue behavior enumeration (FIFO, LIFO)

Enumerator
FIFO	First In First Out behavior.
LIFO	Last In First Out behavior.

Function Documentation

◆ q_drop()

bool q_drop ( Queue_t *const pQ )

Drop current record from queue.

Warning: If using q_push, q_pop, q_peek, q_drop, q_peekItem and/or q_peekPrevious in both interrupts and main application, you shall disable interrupts in main application when using these functions

Note: This function is most likely to be used in conjunction with q_peek

Parameters

[in,out] pQ - pointer of queue to handle

Returns: drop status

Return values

true	if successfully dropped from queue
false	if queue is empty

◆ q_flush()

void q_flush ( Queue_t *const pQ )

Flush queue, restarting from empty queue.

Parameters

[in,out] pQ - pointer of queue to handle

◆ q_getCount()

uint16_t q_getCount ( const Queue_t *const pQ )

get number of records in the queue

Parameters

[in] pQ - pointer of queue to handle

Returns: Number of records stored in the queue

◆ q_getRemainingCount()

uint16_t q_getRemainingCount ( const Queue_t *const pQ )

get number of records left in the queue

Parameters

[in] pQ - pointer of queue to handle

Returns: Number of records left in the queue

◆ q_init()

void * q_init	(	Queue_t *const	pQ,
		const size_t	size_rec,
		const uint16_t	nb_recs,
		const QueueType	type,
		const bool	overwrite )

Queue initialization (using dynamic queue allocation)

Parameters

[in,out]	pQ	- pointer of queue to handle
[in]	size_rec	- size of a record in the queue (in bytes)
[in]	nb_recs	- number of records in the queue
[in]	type	- Queue implementation type: FIFO, LIFO
[in]	overwrite	- Overwrite previous records when queue is full

Returns: NULL when allocation not possible, Queue tab address when successful

Here is the call graph for this function:

◆ q_init_static()

void * q_init_static	(	Queue_t *const	pQ,
		const size_t	size_rec,
		const uint16_t	nb_recs,
		const QueueType	type,
		const bool	overwrite,
		void *const	pQDat,
		const size_t	lenQDat )

Queue initialization (using static queue)

Parameters

[in,out]	pQ	- pointer of queue to handle
[in]	size_rec	- size of a record in the queue (in bytes)
[in]	nb_recs	- number of records in the queue
[in]	type	- Queue implementation type: FIFO, LIFO
[in]	overwrite	- Overwrite previous records when queue is full
[in]	pQDat	- Pointer to static data queue
[in]	lenQDat	- Length of static data queue (in bytes) for static array size check against required size for queue

Returns: Queue tab address (to remain consistent with q_init)

Here is the call graph for this function:

◆ q_isEmpty()

bool q_isEmpty ( const Queue_t *const pQ )

get emptiness state of the queue

Parameters

[in] pQ - pointer of queue to handle

Returns: Queue emptiness status

Return values

true	if queue is empty
false	is not empty

◆ q_isFull()

bool q_isFull ( const Queue_t *const pQ )

get fullness state of the queue

Parameters

[in] pQ - pointer of queue to handle

Returns: Queue fullness status

Return values

true	if queue is full
false	is not full

◆ q_isInitialized()

bool q_isInitialized ( const Queue_t *const pQ )

get initialization state of the queue

Parameters

[in] pQ - pointer of queue to handle

Returns: Queue initialization status

Return values

true	if queue is allocated
false	is queue is not allocated

◆ q_kill()

void q_kill ( Queue_t *const pQ )

Queue destructor: release dynamically allocated queue.

Parameters

[in,out] pQ - pointer of queue to handle

Here is the caller graph for this function:

◆ q_peek()

bool q_peek	(	const Queue_t *const	pQ,
		void *const	record )

Peek record from queue.

Warning: If using q_push, q_pop, q_peek, q_drop, q_peekItem and/or q_peekPrevious in both interrupts and main application, you shall disable interrupts in main application when using these functions

Note: This function is most likely to be used in conjunction with q_drop

Parameters

[in]	pQ	- pointer of queue to handle
[in,out]	record	- pointer to record to be peeked from queue

Returns: Peek status

Return values

true	if successfully peeked from queue
false	if queue is empty

◆ q_peekIdx()

bool q_peekIdx	(	const Queue_t *const	pQ,
		void *const	record,
		const uint16_t	idx )

Peek record at index from queue.

Warning: If using q_push, q_pop, q_peek, q_drop, q_peekItem and/or q_peekPrevious in both interrupts and main application, you shall disable interrupts in main application when using these functions

Note: This function is only useful if searching for a duplicate record and shouldn't be used in conjunction with q_drop

Parameters

[in]	pQ	- pointer of queue to handle
[in,out]	record	- pointer to record to be peeked from queue
[in]	idx	- index of the record to pick

Returns: Peek status

Return values

true	if successfully peeked from queue
false	if index is out of range

Here is the caller graph for this function:

◆ q_peekPrevious()

bool q_peekPrevious	(	const Queue_t *const	pQ,
		void *const	record )

Peek previous record from queue.

Warning: If using q_push, q_pop, q_peek, q_drop, q_peekItem and/or q_peekPrevious in both interrupts and main application, you shall disable interrupts in main application when using these functions

Note: This inline is only useful with FIFO implementation, use q_peek instead with a LIFO (will lead to the same result)

Parameters

[in]	pQ	- pointer of queue to handle
[in,out]	record	- pointer to record to be peeked from queue

Returns: Peek status

Return values

true	if successfully peeked from queue
false	if queue is empty

Here is the call graph for this function:

◆ q_pop()

bool q_pop	(	Queue_t *const	pQ,
		void *const	record )

Pop record from queue.

Warning: If using q_push, q_pop, q_peek, q_drop, q_peekItem and/or q_peekPrevious in both interrupts and main application, you shall disable interrupts in main application when using these functions

Parameters

[in]	pQ	- pointer of queue to handle
[in,out]	record	- pointer to record to be popped from queue

Returns: Pop status

Return values

true	if successfully pulled from queue
false	if queue is empty

◆ q_push()

bool q_push	(	Queue_t *const	pQ,
		const void *const	record )

Push record to queue.

Warning: If using q_push, q_pop, q_peek, q_drop, q_peekItem and/or q_peekPrevious in both interrupts and main application, you shall disable interrupts in main application when using these functions

Parameters

[in,out]	pQ	- pointer of queue to handle
[in]	record	- pointer to record to be pushed into queue

Returns: Push status

Return values

true	if successfully pushed into queue
false	if queue is full

◆ q_sizeof()

uint32_t q_sizeof ( const Queue_t *const pQ )

get size of queue

Remarks: Size in bytes (like sizeof)

Parameters

[in] pQ - pointer of queue to handle

Returns: Size of queue in bytes

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ q_clean

◆ q_init_def

◆ q_nbRecs

◆ q_pull

Typedef Documentation

◆ Queue_t

◆ QueueType

Enumeration Type Documentation

◆ enumQueueType

Function Documentation

◆ q_drop()

◆ q_flush()

◆ q_getCount()

◆ q_getRemainingCount()

◆ q_init()

◆ q_init_static()

◆ q_isEmpty()

◆ q_isFull()

◆ q_isInitialized()

◆ q_kill()

◆ q_peek()

◆ q_peekIdx()

◆ q_peekPrevious()

◆ q_pop()

◆ q_push()

◆ q_sizeof()