qequeue.h

Go to the documentation of this file.

/*****************************************************************************
* Product:  QF/C
* Last Updated for Version: 4.0.00
* Date of the Last Update:  Apr 05, 2008
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2008 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

#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

/****************************************************************************/
typedef struct QEQueueTag {
    QEvent const *frontEvt;

    QEvent const **ring;

    QEQueueCtr end;

    QEQueueCtr head;

    QEQueueCtr tail;

    QEQueueCtr nFree;

    QEQueueCtr nMin;
} QEQueue;

/* public methods */

void QEQueue_init(QEQueue *me, QEvent const *qSto[], QEQueueCtr qLen);

void QEQueue_postFIFO(QEQueue *me, QEvent const *e);

void QEQueue_postLIFO(QEQueue *me, QEvent const *e);

QEvent const *QEQueue_get(QEQueue *me);

#define QEQueue_getNFree(me_) ((me_)->nFree)

/* friend class QF */
/* friend class QActive */

#endif                                                         /* qequeue_h */