CAPT_ByteQueue.h

Go to the documentation of this file.

//*****************************************************************************
// CAPT_ByteQueue.h
//
//
//
//
//*****************************************************************************
//*****************************************************************************
//*****************************************************************************

#ifndef BYTEQUEUE_H_
#define BYTEQUEUE_H_

#ifndef S_SPLINT_S
#include <stdint.h>
#include <stdbool.h>
#endif

//*****************************************************************************
//
//
//
//*****************************************************************************
typedef struct
{
        //
        //
        uint8_t* QueueArray;

        //
        //
        uint16_t ui16QueueArraySize;

        //
        //
        uint16_t ui16QueueHead;

        //
        //
        uint16_t ui16QueueTail;

} tByteQueue;

//*****************************************************************************
//
//
//
//*****************************************************************************
enum tByteQueueError
{
        //
        //
        eByteQueue_Success = 0,

        //
        //
        eByteQueue_QueueEmpty = -1,

        //
        //
        eByteQueue_QueueOverrun = -2,
};

//
// Byte Queue External "Public" Function Prototypes
//

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern bool CAPT_initByteQueue(tByteQueue *pQueue, uint8_t *pBufferArray,
                uint16_t ui16BufferArraySize);
                
//*****************************************************************************
//
//
//*****************************************************************************
extern int8_t CAPT_pushOntoByteQueue(tByteQueue *pQueue, uint8_t ui8DataToAdd);

//*****************************************************************************
//
//
//*****************************************************************************
extern int8_t CAPT_pullFromByteQueue(tByteQueue *pQueue, uint8_t *pDestination);

//*****************************************************************************
//
//
//*****************************************************************************
extern uint16_t CAPT_getByteQueueSize(tByteQueue *pQueue);

//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_isByteQueueFull(tByteQueue *pQueue);

//*****************************************************************************
//
//
//*****************************************************************************
extern bool CAPT_isByteQueueEmpty(tByteQueue *pQueue);

#endif /* BYTEQUEUE_H_ */
//*****************************************************************************
//*****************************************************************************