qequeue.h

Go to the documentation of this file.

// Product: QF/C++, platform-independent event queue interface.
// Last Updated for Version: 4.2.00
// Date of the Last Update:  Jul 05, 2011
//
//                    Q u a n t u m     L e a P s
//                    ---------------------------
//                    innovating embedded systems
//
// Copyright (C) 2002-2011 Quantum Leaps, LLC. All rights reserved.
//
// This software may be distributed and modified under the terms of the GNU
// General Public License version 2 (GPL) as published by the Free Software
// Foundation and appearing in the file GPL.TXT included in the packaging of
// this file. Please note that GPL Section 2[b] requires that all works based
// on this software must also be made publicly available under the terms of
// the GPL ("Copyleft").
//
// Alternatively, this software may be distributed and modified under the
// terms of Quantum Leaps commercial licenses, which expressly supersede
// the GPL and are specifically designed for licensees interested in
// retaining the proprietary status of their code.
//
// Contact information:
// Quantum Leaps Web site:  http://www.quantum-leaps.com
// e-mail:                  info@quantum-leaps.com
#ifndef qequeue_h
#define qequeue_h


#ifdef Q_USE_NAMESPACE
namespace QP {
#endif

#ifndef QF_EQUEUE_CTR_SIZE

    #define QF_EQUEUE_CTR_SIZE 1
#endif
#if (QF_EQUEUE_CTR_SIZE == 1)

    typedef uint8_t QEQueueCtr;
#elif (QF_EQUEUE_CTR_SIZE == 2)
    typedef uint16_t QEQueueCtr;
#elif (QF_EQUEUE_CTR_SIZE == 4)
    typedef uint32_t QEQueueCtr;
#else
    #error "QF_EQUEUE_CTR_SIZE defined incorrectly, expected 1, 2, or 4"
#endif


class QEQueue {
private:

    QEvent const *m_frontEvt;

    QEvent const **m_ring;

    QEQueueCtr m_end;

    QEQueueCtr m_head;

    QEQueueCtr m_tail;

    QEQueueCtr m_nFree;

    QEQueueCtr m_nMin;

public:

    void init(QEvent const *qSto[], QEQueueCtr qLen);

    void postFIFO(QEvent const *e);

    void postLIFO(QEvent const *e);

    QEvent const *get(void);

    QEQueueCtr getNFree(void) const {
        return m_nFree;
    }

private:
    friend class QF;
    friend class QActive;
};

#ifdef Q_USE_NAMESPACE
}                                                              // namespace QP
#endif

#endif                                                            // qequeue_h