qqueues.h

 
#ifndef QQUEUES_H
    #define QQUEUES_H
 
    #include "qtypes.h"
    #include "qcritical.h"
    #include <string.h>
 
    #ifdef __cplusplus
    extern "C" {
    #endif
 
    #ifndef Q_QUEUES
        #define Q_QUEUES        ( 1 )
    #endif
 
    typedef struct _qQueue_s { // skipcq: CXX-E2000
        struct _qQueue_Private_s { // skipcq: CXX-E2000
            qUINT8_t *head;                 /*< Points to the beginning of the queue storage area. */
            qUINT8_t *tail;                 /*< Points to the byte at the end of the queue storage area.  Once more byte is allocated than necessary to store the queue items, this is used as a marker. */
            qUINT8_t *writer;               /*< Points to the free next place in the storage area. */
            qUINT8_t *reader;               /*< Points to the last place that a queued item was read from. */
            volatile size_t itemsWaiting;   /*< The number of items currently in the queue. */
            size_t itemsCount;              /*< The length of the queue defined as the number of items it will hold, not the number of bytes. */
            size_t itemSize;                /*< The size of each items that the queue will hold. */
        }
        qPrivate;
    }
    qQueue_t;
 
    #define QUEUE_SEND_TO_BACK     ( 0U )
 
    #define QUEUE_SEND_TO_FRONT    ( 1U )
 
    typedef qUINT8_t qQueue_InsertMode_t;
 
    qBool_t qQueue_IsReady( const qQueue_t * const q );
 
    qBool_t qQueue_Setup( qQueue_t * const q,
                          void* pData,
                          const size_t itemSize,
                          const size_t itemsCount );
 
    qBool_t qQueue_Reset( qQueue_t * const q );
 
    qBool_t qQueue_IsEmpty( const qQueue_t * const q );
 
    size_t qQueue_Count( const qQueue_t * const q );
 
    size_t qQueue_ItemsAvailable( const qQueue_t * const q );
 
    qBool_t qQueue_IsFull( const qQueue_t * const q );
 
    void* qQueue_Peek( const qQueue_t * const q );
 
    qBool_t qQueue_RemoveFront( qQueue_t * const q );
 
    qBool_t qQueue_Receive( qQueue_t * const q,
                            void *dst );
 
    qBool_t qQueue_Send( qQueue_t * const q,
                         void *itemToQueue,
                         const qQueue_InsertMode_t pos );
 
    #ifdef __cplusplus
    }
    #endif
 
#endif