timer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28
29 #pragma once
30
31 #include <memory>
32 #include <functional>
33
34 namespace clan
35 {
36
37 class TimerImpl;
38
40 class Timer
41 {
44 public:
46 Timer();
47
49 bool is_repeating() const;
50
52 unsigned int get_timeout() const;
54
57 public:
59 std::function<void()> &func_expired();
61
64 public:
66 void start(unsigned int timeout, bool repeat=true);
67
69 void stop();
71
74 private:
75 std::shared_ptr<TimerImpl> impl;
77 };
78
79 }
clan
Definition: clanapp.h:35
clan::Timer::func_expired
std::function< void()> & func_expired()
Callback invoked every time the timer interval occurs.
clan::Timer::Timer
Timer()
Creates a timer object.
clan::Timer::get_timeout
unsigned int get_timeout() const
Returns the current timeout. In milliseconds.
clan::Timer::stop
void stop()
Stop the timer.
clan::Timer::start
void start(unsigned int timeout, bool repeat=true)
Starts the timer. Timeout in milliseconds.
clan::Timer
Timer class that invokes a callback on a specified interval.
Definition: timer.h:40
clan::Timer::is_repeating
bool is_repeating() const
Returns true if the timer repeats until it is stopped.