PriorityQueue.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/Generic/PriorityQueue.hpp
// \brief priority queue implementation definitions for Os::Queue
// ======================================================================
#include "Os/Condition.hpp"
#include "Os/Generic/Types/MaxHeap.hpp"
#include "Os/Mutex.hpp"
#include "Os/Queue.hpp"
#ifndef OS_GENERIC_PRIORITYQUEUE_HPP
#define OS_GENERIC_PRIORITYQUEUE_HPP

namespace Os {
namespace Generic {

struct PriorityQueueHandle : public QueueHandle {
    Types::MaxHeap m_heap;            
    U8* m_data = nullptr;             
    FwSizeType* m_indices = nullptr;  
    FwSizeType* m_sizes = nullptr;    
    FwSizeType m_depth = 0;           
    FwSizeType m_startIndex = 0;      
    FwSizeType m_stopIndex = 0;       
    FwSizeType m_maxSize = 0;         
    FwSizeType m_highMark = 0;        
    Os::Mutex m_data_lock;            
    Os::ConditionVariable m_full;     
    Os::ConditionVariable m_empty;    

    FwSizeType find_index();

    void return_index(FwSizeType index);

    void store_data(FwSizeType index, const U8* source, FwSizeType size);

    void load_data(FwSizeType index, U8* destination, FwSizeType capacity);
};
class PriorityQueue : public Os::QueueInterface {
  public:
    PriorityQueue() = default;

    virtual ~PriorityQueue();

    PriorityQueue(const QueueInterface& other) = delete;

    PriorityQueue(const QueueInterface* other) = delete;

    PriorityQueue& operator=(const QueueInterface& other) override = delete;

    Status create(const Fw::StringBase& name, FwSizeType depth, FwSizeType messageSize) override;

    Status send(const U8* buffer, FwSizeType size, FwQueuePriorityType priority, BlockingType blockType) override;

    Status receive(U8* destination,
                   FwSizeType capacity,
                   BlockingType blockType,
                   FwSizeType& actualSize,
                   FwQueuePriorityType& priority) override;

    FwSizeType getMessagesAvailable() const override;

    FwSizeType getMessageHighWaterMark() const override;

    QueueHandle* getHandle() override;

    PriorityQueueHandle m_handle;
};
}  // namespace Generic
}  // namespace Os

#endif  // OS_GENERIC_PRIORITYQUEUE_HPP