blob: c020d3561352b0b43c567fd3cc41af63ba46f399 (
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/**
* \file
* \brief SoftwareTimerControlBlock 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_SOFTWARETIMERCONTROLBLOCK_HPP_
#define INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERCONTROLBLOCK_HPP_
#include "distortos/internal/scheduler/SoftwareTimerListNode.hpp"
namespace distortos
{
class SoftwareTimer;
namespace internal
{
/// SoftwareTimerControlBlock class is a control block of software timer
class SoftwareTimerControlBlock : public SoftwareTimerListNode
{
public:
/// type of runner for software timer's function
using FunctionRunner = void(SoftwareTimer&);
/**
* \brief SoftwareTimerControlBlock's constructor
*
* \param [in] functionRunner is a reference to runner for software timer's function
* \param [in] owner is a reference to SoftwareTimer object that owns this SoftwareTimerControlBlock
*/
constexpr SoftwareTimerControlBlock(FunctionRunner& functionRunner, SoftwareTimer& owner) :
SoftwareTimerListNode{},
functionRunner_{functionRunner},
owner_{owner}
{
}
/**
* \brief SoftwareTimerControlBlock's destructor
*
* If the timer is running it is stopped.
*/
~SoftwareTimerControlBlock()
{
stop();
}
/**
* \return true if the timer is running, false otherwise
*/
bool isRunning() const
{
return node.isLinked();
}
/**
* \brief Runs software timer's function.
*
* \note this should only be called by SoftwareTimerSupervisor::tickInterruptHandler()
*/
void run() const
{
functionRunner_(owner_);
}
/**
* \brief Starts the timer.
*
* \param [in] timePoint is the time point at which the function will be executed
*/
void start(TickClock::time_point timePoint);
/**
* \brief Stops the timer.
*/
void stop();
SoftwareTimerControlBlock(const SoftwareTimerControlBlock&) = delete;
SoftwareTimerControlBlock(SoftwareTimerControlBlock&&) = default;
const SoftwareTimerControlBlock& operator=(const SoftwareTimerControlBlock&) = delete;
SoftwareTimerControlBlock& operator=(SoftwareTimerControlBlock&&) = delete;
private:
/// reference to runner for software timer's function
FunctionRunner& functionRunner_;
/// reference to SoftwareTimer object that owns this SoftwareTimerControlBlock
SoftwareTimer& owner_;
};
} // namespace internal
} // namespace distortos
#endif // INCLUDE_DISTORTOS_INTERNAL_SCHEDULER_SOFTWARETIMERCONTROLBLOCK_HPP_
|
