mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 17:47:10 -06:00
cddf38bb6f
* Queues use MemAllocator pattern * Derive queue allocation from MallocRegistry * Formatting * Fix UTs * Fix CI * Fix alignment in UT * Formatting and sp * Formatting, bad header * More formatting * Add queue teardown * Deinit components * Fix priority queue test * Fix bug in priority queue allocation * Correct comments * Fix FppTest and Ref UTs * Fix max heap teardown * Fix review comment on max heap * Fix null -> nullptr
99 lines
3.8 KiB
C++
99 lines
3.8 KiB
C++
// ======================================================================
|
|
// \title Os/Stub/Queue.hpp
|
|
// \brief stub definitions for Os::Queue
|
|
// ======================================================================
|
|
#ifndef OS_STUB_QUEUE_HPP
|
|
#define OS_STUB_QUEUE_HPP
|
|
#include "Os/Queue.hpp"
|
|
|
|
namespace Os {
|
|
namespace Stub {
|
|
namespace Queue {
|
|
|
|
struct StubQueueHandle : public QueueHandle {};
|
|
|
|
//! \brief stub queue implementation with injectable statuses
|
|
class StubQueue : public QueueInterface {
|
|
public:
|
|
//! \brief default queue interface constructor
|
|
StubQueue() = default;
|
|
|
|
//! \brief default queue destructor
|
|
virtual ~StubQueue() = default;
|
|
|
|
//! \brief copy constructor is forbidden
|
|
StubQueue(const QueueInterface& other) = delete;
|
|
|
|
//! \brief copy constructor is forbidden
|
|
StubQueue(const QueueInterface* other) = delete;
|
|
|
|
//! \brief assignment operator is forbidden
|
|
StubQueue& operator=(const QueueInterface& other) override = delete;
|
|
|
|
//! \brief create queue storage
|
|
//!
|
|
//! Creates a queue ensuring sufficient storage to hold `depth` messages of `messageSize` size each.
|
|
//! \param id: identifier of queue
|
|
//! \param name: name of queue
|
|
//! \param depth: depth of queue in number of messages
|
|
//! \param messageSize: size of an individual message
|
|
//! \return: status of the creation
|
|
Status create(FwEnumStoreType id,
|
|
const Fw::ConstStringBase& name,
|
|
FwSizeType depth,
|
|
FwSizeType messageSize) override;
|
|
|
|
//! \brief send a message into the queue
|
|
//!
|
|
//! Send a message into the queue, providing the message data, size, priority, and blocking type. When
|
|
//! `blockType` is set to BLOCKING, this call will block on queue full. Otherwise, this will return an error
|
|
//! status on queue full.
|
|
//!
|
|
//! \param buffer: message data
|
|
//! \param size: size of message data
|
|
//! \param priority: priority of the message
|
|
//! \param blockType: BLOCKING to block for space or NONBLOCKING to return error when queue is full
|
|
//! \return: status of the send
|
|
Status send(const U8* buffer, FwSizeType size, FwQueuePriorityType priority, BlockingType blockType) override;
|
|
|
|
//! \brief receive a message from the queue
|
|
//!
|
|
//! Receive a message from the queue, providing the message destination, capacity, priority, and blocking type.
|
|
//! When `blockType` is set to BLOCKING, this call will block on queue empty. Otherwise, this will return an
|
|
//! error status on queue empty. Actual size received and priority of message is set on success status.
|
|
//!
|
|
//! \param destination: destination for message data
|
|
//! \param capacity: maximum size of message data
|
|
//! \param blockType: BLOCKING to wait for message or NONBLOCKING to return error when queue is empty
|
|
//! \param actualSize: (output) actual size of message read
|
|
//! \param priority: (output) priority of message read
|
|
//! \return: status of the send
|
|
Status receive(U8* destination,
|
|
FwSizeType capacity,
|
|
BlockingType blockType,
|
|
FwSizeType& actualSize,
|
|
FwQueuePriorityType& priority) override;
|
|
|
|
//! \brief get number of messages available
|
|
//!
|
|
//! \return number of messages available
|
|
FwSizeType getMessagesAvailable() const override;
|
|
|
|
//! \brief get maximum messages stored at any given time
|
|
//!
|
|
//! Returns the maximum number of messages in this queue at any given time. This is the high-water mark for this
|
|
//! queue.
|
|
//! \return queue message high-water mark
|
|
FwSizeType getMessageHighWaterMark() const override;
|
|
|
|
QueueHandle* getHandle() override;
|
|
|
|
StubQueueHandle m_handle;
|
|
};
|
|
|
|
} // namespace Queue
|
|
} // namespace Stub
|
|
} // namespace Os
|
|
|
|
#endif // OS_STUB_QUEUE_HPP
|