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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/*
* Copyright (c) 2016, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Ford Motor Company nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SRC_COMPONENTS_UTILS_INCLUDE_UTILS_TIMER_H_
#define SRC_COMPONENTS_UTILS_INCLUDE_UTILS_TIMER_H_
#include <string>
#include <stdint.h>
#include <memory>
#include "utils/macro.h"
#include "utils/lock.h"
#include "utils/timer_task.h"
#include "utils/threads/thread.h"
#include "utils/threads/thread_delegate.h"
namespace timer {
typedef uint32_t Milliseconds;
/**
* @brief Enumeration listing of possible timer types.
* Single shot timer signals only once and then stops counting.
* Periodic timer signals every time specific value is reached
* and then restarts.
*/
enum TimerType {
/**
* @brief Periodic calls to task
*/
kPeriodic = 0,
/**
* @brief Single call to task
*/
kSingleShot = 1
};
/**
* @brief Timer calls custom callback function after
* specified timeout has been elapsed.
* Thread-safe class
*/
class Timer {
public:
/**
* @brief Constructor
* Does not start timer
* @param name Timer name for identification
* @param task Task for tracking
*/
Timer(const std::string& name, TimerTask* task);
/**
* @brief Destructor
* Stops timer if it's running
*/
~Timer();
/**
* @brief Starts timer with specified timeout
* @param timeout Timer timeout
* @param enum timer_type Timer type enum value.
*/
void Start(const Milliseconds timeout, const TimerType timer_type);
/**
* @brief Stops timer if it's running
*/
void Stop();
/**
* @brief Gets current timer status
* @return True in case of timer is running, false otherwise
*/
bool is_running() const;
/**
* @brief Gets current timer timeout
* @return Current timeout in milliseconds.
* Null if timer has not been started
*/
Milliseconds timeout() const;
private:
/**
* @brief Delegate for timer thread
*/
class TimerDelegate : public threads::ThreadDelegate {
public:
/**
* @brief Constructor
* @param timer Timer instance pointer for callback calling
*/
TimerDelegate(const Timer* timer, sync_primitives::Lock& state_lock_ref);
/**
* @brief Sets timer timeout
* @param timeout Timeout in milliseconds to be set
*/
void set_timeout(const Milliseconds timeout);
/**
* @brief Gets timer timeout
* @return Timer timeout
*/
Milliseconds timeout() const;
/**
* @brief Sets timer delegate stop flag
* @param stop_flag Bool flag to be set
*/
void set_stop_flag(const bool stop_flag);
/**
* @brief Gets timer delegate stop flag
* @return Delegate stop flag
*/
bool stop_flag() const;
/**
* @brief Sets timer delegate finalized flag
* @param finalized_flag Bool flag to be set
*/
void set_finalized_flag(const bool finalized_flag);
/**
* @brief Gets timer delegate finalized flag
* @return Delegate finalized flag
*/
bool finalized_flag() const;
void threadMain() OVERRIDE;
void exitThreadMain() OVERRIDE;
private:
const Timer* timer_;
Milliseconds timeout_;
/**
* @brief Stop flag shows if timer should be stopped
* after next iteration
*/
bool stop_flag_;
/**
* @brief Finalized flag shows if timer is finalized
* and cannot be restarted until actual thread stopping
*/
bool finalized_flag_;
sync_primitives::Lock& state_lock_ref_;
sync_primitives::ConditionalVariable state_condition_;
DISALLOW_COPY_AND_ASSIGN(TimerDelegate);
};
/**
* @brief Sets up timer delegate to start state.
* Not thread-safe
* @param timeout Timer timeout
*/
void StartDelegate(const Milliseconds timeout) const;
/**
* @brief Sets up timer delegate to stop state.
* Not thread-safe
*/
void StopDelegate() const;
/**
* @brief Starts timer thread.
* Not thread-safe
*/
void StartThread();
/**
* @brief Stops timer thread.
* Not thread-safe
*/
void StopThread();
/**
* @brief Callback called on timeout.
* Not thread-safe
*/
void OnTimeout() const;
const std::string name_;
TimerTask* task_;
mutable sync_primitives::Lock state_lock_;
mutable std::auto_ptr<TimerDelegate> delegate_;
threads::Thread* thread_;
/**
* @brief Single shot flag shows if timer should be fired once
*/
bool single_shot_;
DISALLOW_COPY_AND_ASSIGN(Timer);
};
} // namespace timer
#endif // SRC_COMPONENTS_UTILS_INCLUDE_UTILS_TIMER_H_
|
