aboutsummaryrefslogtreecommitdiffstats
path: root/include/distortos/DynamicFifoQueue.hpp
blob: fba876f743feb82c9156f8674f78da6e1bb65350 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/**
 * \file
 * \brief DynamicFifoQueue 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_DYNAMICFIFOQUEUE_HPP_
#define INCLUDE_DISTORTOS_DYNAMICFIFOQUEUE_HPP_

#include "FifoQueue.hpp"

#include "distortos/internal/memory/storageDeleter.hpp"

namespace distortos
{

/**
 * \brief DynamicFifoQueue class is a variant of FifoQueue that has dynamic storage for queue's contents.
 *
 * \tparam T is the type of data in queue
 *
 * \ingroup queues
 */

template<typename T>
class DynamicFifoQueue : public FifoQueue<T>
{
public:

	/// import Storage type from base class
	using typename FifoQueue<T>::Storage;

	/**
	 * \brief DynamicFifoQueue's constructor
	 *
	 * \param [in] queueSize is the maximum number of elements in queue
	 */

	explicit DynamicFifoQueue(size_t queueSize);
};

template<typename T>
DynamicFifoQueue<T>::DynamicFifoQueue(const size_t queueSize) :
		FifoQueue<T>{{new Storage[queueSize], internal::storageDeleter<Storage>}, queueSize}
{

}

}	// namespace distortos

#endif	// INCLUDE_DISTORTOS_DYNAMICFIFOQUEUE_HPP_