diff options
Diffstat (limited to 'include/distortos/StaticRawFifoQueue.hpp')
-rw-r--r-- | include/distortos/StaticRawFifoQueue.hpp | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/include/distortos/StaticRawFifoQueue.hpp b/include/distortos/StaticRawFifoQueue.hpp new file mode 100644 index 0000000..a271020 --- /dev/null +++ b/include/distortos/StaticRawFifoQueue.hpp @@ -0,0 +1,69 @@ +/** + * \file + * \brief StaticRawFifoQueue class header + * + * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info + * + * \par License + * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not + * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#ifndef INCLUDE_DISTORTOS_STATICRAWFIFOQUEUE_HPP_ +#define INCLUDE_DISTORTOS_STATICRAWFIFOQUEUE_HPP_ + +#include "RawFifoQueue.hpp" + +#include "distortos/internal/memory/dummyDeleter.hpp" + +namespace distortos +{ + +/** + * \brief StaticRawFifoQueue class is a variant of RawFifoQueue that has automatic storage for queue's contents. + * + * \tparam T is the type of data in queue + * \tparam QueueSize is the maximum number of elements in queue + * + * \ingroup queues + */ + +template<typename T, size_t QueueSize> +class StaticRawFifoQueue : public RawFifoQueue +{ +public: + + /// type of uninitialized storage for data + using Storage = typename std::aligned_storage<sizeof(T), alignof(T)>::type; + + /** + * \brief StaticRawFifoQueue's constructor + */ + + explicit StaticRawFifoQueue() : + RawFifoQueue{{storage_.data(), internal::dummyDeleter<Storage>}, sizeof(*storage_.data()), storage_.size()} + { + + } + +private: + + /// storage for queue's contents + std::array<Storage, QueueSize> storage_; +}; + +/** + * \brief StaticRawFifoQueueFromSize type alias is a variant of StaticRawFifoQueue which uses size of element (instead + * of type) as template argument. + * + * \tparam ElementSize is the size of single queue element, bytes + * \tparam QueueSize is the maximum number of elements in queue + */ + +template<size_t ElementSize, size_t QueueSize> +using StaticRawFifoQueueFromSize = + StaticRawFifoQueue<typename std::aligned_storage<ElementSize, ElementSize>::type, QueueSize>; + +} // namespace distortos + +#endif // INCLUDE_DISTORTOS_STATICRAWFIFOQUEUE_HPP_ |