Queue.hpp

Go to the documentation of this file.

/*
 * Queue.hpp:
 *
 * FIFO queue of fixed size messages. For use generally where non-concurrent, non-OS backed based FIFO queues are
 * necessary. Message size is defined at construction time and all messages enqueued and dequeued must be of that fixed
 * size. Wraps circular buffer to perform actual storage of messages. This implementation is not thread safe and the
 * expectation is that the user will wrap it in concurrency constructs where necessary.
 *
 *  Created on: July 5th, 2022
 *      Author: lestarch
 *
 */
#ifndef _UTILS_TYPES_QUEUE_HPP
#define _UTILS_TYPES_QUEUE_HPP
#include <FpConfig.hpp>
#include <Fw/Types/BasicTypes.hpp>
#include <Fw/Types/Serializable.hpp>
#include <Utils/Types/CircularBuffer.hpp>
 
namespace Types {
 
class Queue {
  public:
    Queue();
 
    void setup(U8* const storage, const FwSizeType storage_size, const FwSizeType depth, const FwSizeType message_size);
 
    Fw::SerializeStatus enqueue(const U8* const message, const FwSizeType size);
 
    Fw::SerializeStatus dequeue(U8* const message, const FwSizeType size);
 
    NATIVE_UINT_TYPE get_high_water_mark() const;
 
    void clear_high_water_mark();
 
    NATIVE_UINT_TYPE getQueueSize() const;
 
  private:
    CircularBuffer m_internal;
    FwSizeType m_message_size;
};
}  // namespace Types
#endif  // _UTILS_TYPES_QUEUE_HPP