mirror of
https://github.com/nasa/fprime.git
synced 2025-12-11 22:23:25 -06:00
0659f0940b
* Refactored type organization * Creating better configuration/types header hierarchy * Replace FpConfig type aliases with FPP generated aliases * Add the aliases to the FPP model * Config + Type Aliases builds * Renamed Fw/Types.h,hpp to Fw/FPrimeBasicTypes.h,hpp * Updating to FPP-a7 * Adding newline * sp * Fixing minor nit from review * Spurious ; --------- Co-authored-by: Andrei Tumbar <andrei.tumbar@jpl.nasa.gov>
91 lines
3.5 KiB
C++
91 lines
3.5 KiB
C++
/*
|
|
* 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 <Fw/FPrimeBasicTypes.hpp>
|
|
#include <Fw/Types/BasicTypes.hpp>
|
|
#include <Fw/Types/Serializable.hpp>
|
|
#include <Utils/Types/CircularBuffer.hpp>
|
|
|
|
namespace Types {
|
|
|
|
class Queue {
|
|
public:
|
|
/**
|
|
* \brief constructs an uninitialized queue
|
|
*/
|
|
Queue();
|
|
|
|
/**
|
|
* \brief setup the queue object to setup storage
|
|
*
|
|
* The queue must be configured before use to setup storage parameters. This function supplies those parameters
|
|
* including depth, and message size. Storage size must be greater than or equal to the depth x message size.
|
|
*
|
|
* \param storage: storage memory allocation
|
|
* \param storage_size: size of the provided allocation
|
|
* \param depth: depth of the queue
|
|
* \param message_size: size of individual messages
|
|
*/
|
|
void setup(U8* const storage, const FwSizeType storage_size, const FwSizeType depth, const FwSizeType message_size);
|
|
|
|
/**
|
|
* \brief pushes a fixed-size message onto the back of the queue
|
|
*
|
|
* Pushes a fixed-size message onto the queue. This performs a copy of the data onto the queue so the user is free
|
|
* to dispose the message data as soon as the call returns. Note: message is required to be of the size message_size
|
|
* as defined by the construction of the queue. Size is provided as a safety check to ensure the sent size is
|
|
* consistent with the expected size of the queue.
|
|
*
|
|
* This will return a non-Fw::SERIALIZE_OK status when the queue is full.
|
|
*
|
|
* \param message: message of size m_message_size to enqueue
|
|
* \param size: size of the message being sent. Must be equivalent to queue's message size.
|
|
* \return: Fw::SERIALIZE_OK on success, something else on failure
|
|
*/
|
|
Fw::SerializeStatus enqueue(const U8* const message, const FwSizeType size);
|
|
|
|
/**
|
|
* \brief pops a fixed-size message off the front of the queue
|
|
*
|
|
* Pops a fixed-size message off the front of the queue. This performs a copy of the data into the provided message
|
|
* buffer. Note: message is required to be of the size message_size as defined by the construction of the queue. The
|
|
* size must be greater or equal to message size, although only message size bytes will be used.
|
|
*
|
|
* This will return a non-Fw::SERIALIZE_OK status when the queue is empty.
|
|
*
|
|
* \param message: message of size m_message_size to dequeue
|
|
* \param size: size of the buffer being supplied.
|
|
* \return: Fw::SERIALIZE_OK on success, something else on failure
|
|
*/
|
|
Fw::SerializeStatus dequeue(U8* const message, const FwSizeType size);
|
|
|
|
/**
|
|
* Return the largest tracked allocated size
|
|
*/
|
|
FwSizeType get_high_water_mark() const;
|
|
|
|
/**
|
|
* Clear tracking of the largest allocated size
|
|
*/
|
|
void clear_high_water_mark();
|
|
|
|
FwSizeType getQueueSize() const;
|
|
|
|
private:
|
|
CircularBuffer m_internal;
|
|
FwSizeType m_message_size;
|
|
};
|
|
} // namespace Types
|
|
#endif // _UTILS_TYPES_QUEUE_HPP
|