BufferQueue.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferQueue.hpp
// \author dinkel
// \brief  A generic buffer queue data structure.
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef OS_PTHREADS_BUFFER_QUEUE_HPP
#define OS_PTHREADS_BUFFER_QUEUE_HPP
 
#include <Fw/Types/BasicTypes.hpp>
 
// This is a generic buffer queue interface. 
namespace Os {
 
  class BufferQueue {
    // Public interface:
    public:
    BufferQueue();
    ~BufferQueue();
    bool create(NATIVE_UINT_TYPE depth, NATIVE_UINT_TYPE msgSize);
    bool push(const U8* buffer, NATIVE_UINT_TYPE size, NATIVE_INT_TYPE priority);
    bool pop(U8* buffer, NATIVE_UINT_TYPE& size, NATIVE_INT_TYPE &priority);
    bool isFull();
    bool isEmpty();
    NATIVE_UINT_TYPE getCount();
    NATIVE_UINT_TYPE getMaxCount();
    NATIVE_UINT_TYPE getMsgSize();
    NATIVE_UINT_TYPE getDepth();
 
    // Internal member functions:
    private:
    // Initialize data structures necessary for the queue:
    bool initialize(NATIVE_UINT_TYPE depth, NATIVE_UINT_TYPE msgSize);
    // Destroy queue data structures:
    void finalize();
    // Enqueue a message into the data structure:
    bool enqueue(const U8* buffer, NATIVE_UINT_TYPE size, NATIVE_INT_TYPE priority);
    // Dequeue a message from the data structure:
    bool dequeue(U8* buffer, NATIVE_UINT_TYPE& size, NATIVE_INT_TYPE &priority);
    // Low level enqueue which does the copying onto the queue:
    void enqueueBuffer(const U8* buffer, NATIVE_UINT_TYPE size, U8* data, NATIVE_UINT_TYPE index);
    // Low level dequeue which does the copying from the queue:
    bool dequeueBuffer(U8* buffer, NATIVE_UINT_TYPE& size, U8* data, NATIVE_UINT_TYPE index);
    // Helper function to get the buffer index into the queue for particular
    // queue index.
    NATIVE_UINT_TYPE getBufferIndex(NATIVE_INT_TYPE index);
 
    // Member variables:
    void* queue; // The queue can be implemented in various ways
    NATIVE_UINT_TYPE msgSize; // Max size of message on the queue
    NATIVE_UINT_TYPE depth; // Max number of messages on the queue
    NATIVE_UINT_TYPE count; // Current number of messages on the queue
    NATIVE_UINT_TYPE maxCount; // Maximum number of messages ever seen on the queue
  };
}
 
#endif // OS_PTHREADS_BUFFER_QUEUE_HPP