distortos::DynamicMessageQueue< T > Class Template Reference

DynamicMessageQueue class is a variant of MessageQueue that has dynamic storage for queue's contents. More...

#include "distortos/DynamicMessageQueue.hpp"

Inheritance diagram for distortos::DynamicMessageQueue< T >:

Collaboration diagram for distortos::DynamicMessageQueue< T >:

Public Member Functions
	DynamicMessageQueue (size_t queueSize)
	DynamicMessageQueue's constructor. More...
Public Member Functions inherited from distortos::MessageQueue< T >
	MessageQueue (EntryStorageUniquePointer &&entryStorageUniquePointer, ValueStorageUniquePointer &&valueStorageUniquePointer, const size_t maxElements)
	MessageQueue's constructor. More...
	~MessageQueue ()
	MessageQueue's destructor. More...
template<typename... Args>
int	emplace (const uint8_t priority, Args &&... args)
	Emplaces the element in the queue. More...
size_t	getCapacity () const
int	pop (uint8_t &priority, T &value)
	Pops oldest element with highest priority from the queue. More...
int	push (const uint8_t priority, const T &value)
	Pushes the element to the queue. More...
int	push (const uint8_t priority, T &&value)
	Pushes the element to the queue. More...
template<typename... Args>
int	tryEmplace (const uint8_t priority, Args &&... args)
	Tries to emplace the element in the queue. More...
template<typename... Args>
int	tryEmplaceFor (const TickClock::duration duration, const uint8_t priority, Args &&... args)
	Tries to emplace the element in the queue for a given duration of time. More...
template<typename Rep , typename Period , typename... Args>
int	tryEmplaceFor (const std::chrono::duration< Rep, Period > duration, const uint8_t priority, Args &&... args)
	Tries to emplace the element in the queue for a given duration of time. More...
template<typename... Args>
int	tryEmplaceUntil (const TickClock::time_point timePoint, const uint8_t priority, Args &&... args)
	Tries to emplace the element in the queue until a given time point. More...
template<typename Duration , typename... Args>
int	tryEmplaceUntil (const std::chrono::time_point< TickClock, Duration > timePoint, const uint8_t priority, Args &&... args)
	Tries to emplace the element in the queue until a given time point. More...
int	tryPop (uint8_t &priority, T &value)
	Tries to pop oldest element with highest priority from the queue. More...
int	tryPopFor (const TickClock::duration duration, uint8_t &priority, T &value)
	Tries to pop oldest element with highest priority from the queue for a given duration of time. More...
template<typename Rep , typename Period >
int	tryPopFor (const std::chrono::duration< Rep, Period > duration, uint8_t &priority, T &value)
	Tries to pop oldest element with highest priority from the queue for a given duration of time. More...
int	tryPopUntil (const TickClock::time_point timePoint, uint8_t &priority, T &value)
	Tries to pop oldest element with highest priority from the queue until a given time point. More...
template<typename Duration >
int	tryPopUntil (const std::chrono::time_point< TickClock, Duration > timePoint, uint8_t &priority, T &value)
	Tries to pop oldest element with highest priority from the queue until a given time point. More...
int	tryPush (const uint8_t priority, const T &value)
	Tries to push the element to the queue. More...
int	tryPush (const uint8_t priority, T &&value)
	Tries to push the element to the queue. More...
int	tryPushFor (const TickClock::duration duration, const uint8_t priority, const T &value)
	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 uint8_t priority, const T &value)
	Tries to push the element to the queue for a given duration of time. More...
int	tryPushFor (const TickClock::duration duration, const uint8_t priority, T &&value)
	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 uint8_t priority, T &&value)
	Tries to push the element to the queue for a given duration of time. More...
int	tryPushUntil (const TickClock::time_point timePoint, const uint8_t priority, const T &value)
	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 uint8_t priority, const T &value)
	Tries to push the element to the queue until a given time point. More...
int	tryPushUntil (const TickClock::time_point timePoint, const uint8_t priority, T &&value)
	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 uint8_t priority, T &&value)
	Tries to push the element to the queue until a given time point. More...

Additional Inherited Members
Public Types inherited from distortos::MessageQueue< T >
using	EntryStorage = internal::MessageQueueBase::EntryStorage
	type of uninitialized storage for Entry with link More...
using	ValueStorage = internal::MessageQueueBase::ValueStorage< T >
	type of uninitialized storage for value More...
using	ValueType = T
	type of data in queue More...
using	EntryStorageUniquePointer = internal::MessageQueueBase::EntryStorageUniquePointer
	import EntryStorageUniquePointer type from internal::MessageQueueBase class More...
using	ValueStorageUniquePointer = std::unique_ptr< ValueStorage[], internal::MessageQueueBase::ValueStorageUniquePointer::deleter_type >
	unique_ptr (with deleter) to ValueStorage[] More...

Detailed Description

template<typename T>
class distortos::DynamicMessageQueue< T >

DynamicMessageQueue class is a variant of MessageQueue that has dynamic storage for queue's contents.

Template Parameters

T	is the type of data in queue

Constructor & Destructor Documentation

DynamicMessageQueue()

template<typename T >

distortos::DynamicMessageQueue< T >::DynamicMessageQueue ( size_t  queueSize )

explicit

DynamicMessageQueue's constructor.

Parameters

[in]

queueSize

is the maximum number of elements in queue

---

The documentation for this class was generated from the following file:

• include/distortos/DynamicMessageQueue.hpp