aboutsummaryrefslogtreecommitdiffstats
path: root/include/distortos/internal/scheduler/SoftwareTimerSupervisor.hpp
blob: 8367a0af3b1474df2001ad05796afd72aba304d5 (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
57
58
59
60
61
62
63
64
65
66
/**
 * \file
 * \brief SoftwareTimerSupervisor class header
 *
 * \author Copyright (C) 2014-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_INTERNAL_SCHEDULER_SOFTWARETIMERSUPERVISOR_HPP_
#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERSUPERVISOR_HPP_

#include "distortos/internal/scheduler/SoftwareTimerList.hpp"

namespace distortos
{

namespace internal
{

/// SoftwareTimerSupervisor class is a supervisor of software timers
class SoftwareTimerSupervisor
{
public:

	/**
	 * \brief SoftwareTimerControlBlock's constructor
	 */

	constexpr SoftwareTimerSupervisor() :
			activeList_{}
	{

	}

	/**
	 * \brief Adds SoftwareTimerControlBlock to supervisor, effectively starting the software timer.
	 *
	 * \param [in] softwareTimerControlBlock is the SoftwareTimerControlBlock being added/started
	 */

	void add(SoftwareTimerControlBlock& softwareTimerControlBlock);

	/**
	 * \brief Handler of "tick" interrupt.
	 *
	 * \note this must not be called by user code
	 *
	 * \param [in] timePoint is the current time point
	 */

	void tickInterruptHandler(TickClock::time_point timePoint);

private:

	/// list of active software timers (waiting for execution)
	SoftwareTimerList activeList_;
};

}	// namespace internal

}	// namespace distortos

#endif	// INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERSUPERVISOR_HPP_