distortos::DynamicRawFifoQueue Class Reference
DynamicRawFifoQueue class is a variant of RawFifoQueue that has dynamic storage for queue's contents. More...
#include "distortos/DynamicRawFifoQueue.hpp"
Inheritance diagram for distortos::DynamicRawFifoQueue:
Collaboration diagram for distortos::DynamicRawFifoQueue:
Public Member Functions | |
| DynamicRawFifoQueue (size_t elementSize, size_t queueSize) | |
| DynamicRawFifoQueue's constructor. More... | |
 Public Member Functions inherited from distortos::RawFifoQueue | |
| RawFifoQueue (StorageUniquePointer &&storageUniquePointer, size_t elementSize, size_t maxElements) | |
| RawFifoQueue's constructor. More... | |
| size_t | getCapacity () const |
| size_t | getElementSize () const |
| int | pop (void *buffer, size_t size) |
| Pops the oldest (first) element from the queue. More... | |
| template<typename T > | |
| int | pop (T &buffer) |
| Pops the oldest (first) element from the queue. More... | |
| int | push (const void *data, size_t size) |
| Pushes the element to the queue. More... | |
| template<typename T > | |
| int | push (const T &data) |
| Pushes the element to the queue. More... | |
| int | tryPop (void *buffer, size_t size) |
| Tries to pop the oldest (first) element from the queue. More... | |
| template<typename T > | |
| int | tryPop (T &buffer) |
| Tries to pop the oldest (first) element from the queue. More... | |
| int | tryPopFor (TickClock::duration duration, void *buffer, size_t size) |
| Tries to pop the oldest (first) element from the queue for a given duration of time. More... | |
| template<typename Rep , typename Period > | |
| int | tryPopFor (const std::chrono::duration< Rep, Period > duration, void *const buffer, const size_t size) |
| Tries to pop the oldest (first) element from the queue for a given duration of time. More... | |
| template<typename Rep , typename Period , typename T > | |
| int | tryPopFor (const std::chrono::duration< Rep, Period > duration, T &buffer) |
| Tries to pop the oldest (first) element from the queue for a given duration of time. More... | |
| int | tryPopUntil (TickClock::time_point timePoint, void *buffer, size_t size) |
| Tries to pop the oldest (first) element from the queue until a given time point. More... | |
| template<typename Duration > | |
| int | tryPopUntil (const std::chrono::time_point< TickClock, Duration > timePoint, void *const buffer, const size_t size) |
| Tries to pop the oldest (first) element from the queue until a given time point. More... | |
| template<typename Duration , typename T > | |
| int | tryPopUntil (const std::chrono::time_point< TickClock, Duration > timePoint, T &buffer) |
| Tries to pop the oldest (first) element from the queue until a given time point. More... | |
| int | tryPush (const void *data, size_t size) |
| Tries to push the element to the queue. More... | |
| template<typename T > | |
| int | tryPush (const T &data) |
| Tries to push the element to the queue. More... | |
| int | tryPushFor (TickClock::duration duration, const void *data, size_t size) |
| Tries to push the element to the queue for a given duration of time. More... | |
| template<typename Rep , typename Period > | |
| int | tryPushFor (const std::chrono::duration< Rep, Period > duration, const void *const data, const size_t size) |
| Tries to push the element to the queue for a given duration of time. More... | |
| template<typename Rep , typename Period , typename T > | |
| int | tryPushFor (const std::chrono::duration< Rep, Period > duration, const T &data) |
| Tries to push the element to the queue for a given duration of time. More... | |
| int | tryPushUntil (TickClock::time_point timePoint, const void *data, size_t size) |
| Tries to push the element to the queue until a given time point. More... | |
| template<typename Duration > | |
| int | tryPushUntil (const std::chrono::time_point< TickClock, Duration > timePoint, const void *const data, const size_t size) |
| Tries to push the element to the queue until a given time point. More... | |
| template<typename Duration , typename T > | |
| int | tryPushUntil (const std::chrono::time_point< TickClock, Duration > timePoint, const T &data) |
| Tries to push the element to the queue until a given time point. More... | |
Additional Inherited Members | |
| Public Types inherited from distortos::RawFifoQueue | |
| using | StorageUniquePointer = internal::FifoQueueBase::StorageUniquePointer |
| unique_ptr (with deleter) to storage More... | |
Detailed Description
DynamicRawFifoQueue class is a variant of RawFifoQueue that has dynamic storage for queue's contents.
Constructor & Destructor Documentation
◆ DynamicRawFifoQueue()
| distortos::DynamicRawFifoQueue::DynamicRawFifoQueue | ( | size_t | elementSize, |
| size_t | queueSize | ||
| ) |
DynamicRawFifoQueue's constructor.
- Parameters
-
[in] elementSize is the size of single queue element, bytes [in] queueSize is the maximum number of elements in queue
The documentation for this class was generated from the following files:
- include/distortos/DynamicRawFifoQueue.hpp
- source/synchronization/DynamicRawFifoQueue.cpp
