cQueue.h

Go to the documentation of this file.

 
/****************************************************************/
#ifndef CQUEUE_H_
    #define CQUEUE_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <inttypes.h>
#include <stdbool.h>
#include <stddef.h>
/****************************************************************/
 
 
#define q_init_def(q, sz)   q_init(q, sz, 20, FIFO, false)  
 
#define q_pull              q_pop                           
#define q_nbRecs            q_getCount                      
#define q_clean             q_flush                         
 
 
typedef enum enumQueueType {
    FIFO = 0,   
    LIFO = 1    
} QueueType;
 
 
typedef struct Queue_t {
    QueueType   impl;       
    bool        ovw;        
    bool        dynamic;    
    size_t      queue_sz;   
    size_t      rec_sz;     
    uint16_t    rec_nb;     
    uint8_t *   queue;      
 
    uint16_t    in;         
    uint16_t    out;        
    uint16_t    cnt;        
    uint16_t    init;       
} Queue_t;
 
 
/*****************/
/*** FUNCTIONS ***/
/*****************/
void * __attribute__((nonnull)) q_init( Queue_t * const pQ,
                                        const size_t size_rec, const uint16_t nb_recs,
                                        const QueueType type, const bool overwrite);
 
void * __attribute__((nonnull(1))) 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);
 
void __attribute__((nonnull)) q_kill(Queue_t * const pQ);
 
void __attribute__((nonnull)) q_flush(Queue_t * const pQ);
 
bool __attribute__((nonnull)) q_push(Queue_t * const pQ, const void * const record);
 
bool __attribute__((nonnull)) q_pop(Queue_t * const pQ, void * const record);
 
bool __attribute__((nonnull)) q_peek(const Queue_t * const pQ, void * const record);
 
bool __attribute__((nonnull)) q_drop(Queue_t * const pQ);
 
bool __attribute__((nonnull)) q_peekIdx(const Queue_t * const pQ, void * const record, const uint16_t idx);
 
bool __attribute__((nonnull)) q_peekPrevious(const Queue_t * const pQ, void * const record);
 
 
/***************/
/*** GETTERS ***/
/***************/
bool __attribute__((nonnull)) q_isInitialized(const Queue_t * const pQ);
 
uint32_t __attribute__((nonnull)) q_sizeof(const Queue_t * const pQ);
 
bool __attribute__((nonnull)) q_isEmpty(const Queue_t * const pQ);
 
bool __attribute__((nonnull)) q_isFull(const Queue_t * const pQ);
 
uint16_t __attribute__((nonnull)) q_getCount(const Queue_t * const pQ);
 
uint16_t __attribute__((nonnull)) q_getRemainingCount(const Queue_t * const pQ);
 
 
/****************************************************************/
#ifdef __cplusplus
}
#endif
 
#endif /* CQUEUE_H_ */
/****************************************************************/