cppQueue.h

Go to the documentation of this file.

/****************************************************************/
#ifndef CPPQUEUE_H_
    #define CPPQUEUE_H_
 
#include <cinttypes>
#include <cstddef>
/****************************************************************/
 

typedef enum {
    FIFO = 0,   
    LIFO = 1    
} cppQueueType;
 

class cppQueue
{
private:
    cppQueueType    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;       
 
    inline bool _isInitialized(void) const __attribute__((always_inline));
    inline bool _isEmpty(void) const __attribute__((always_inline));
    inline bool _isFull(void) const __attribute__((always_inline));
    inline uint16_t _getCount(void) const __attribute__((always_inline));
public:
    cppQueue(const size_t size_rec, const uint16_t nb_recs=20, const cppQueueType type=FIFO, const bool overwrite=false, void * const pQDat=NULL, const size_t lenQDat=0);

    ~cppQueue();

    void flush(void);

    inline void clean(void) __attribute__((always_inline)) {
        flush(); }

    bool isInitialized(void) const;

    bool isEmpty(void) const;

    bool isFull(void) const;

    uint32_t sizeOf(void) const;

    uint16_t getCount(void) const;

    inline uint16_t nbRecs(void) const __attribute__((always_inline)) {
        return getCount(); }

    uint16_t getRemainingCount(void) const;

    bool push(const void * const record) __attribute__((nonnull));

    bool pop(void * const record) __attribute__((nonnull));

    inline bool pull(void * const record) __attribute__((nonnull,always_inline)) {
        return pop(record); }

    bool peek(void * const record) __attribute__((nonnull));

    bool drop(void);

    bool peekIdx(void * const record, const uint16_t idx) __attribute__((nonnull));

    bool peekPrevious(void * const record) __attribute__((nonnull));
};
 
 
/****************************************************************/
#endif /* CPPQUEUE_H_ */
/****************************************************************/