timer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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  class TimerImpl;
37 
39  class Timer
40  {
41  public:
43  Timer();
44 
46  bool is_repeating() const;
47 
49  unsigned int get_timeout() const;
50 
52  std::function<void()> &func_expired();
53 
55  void start(unsigned int timeout, bool repeat = true);
56 
58  void stop();
59 
60  private:
61  std::shared_ptr<TimerImpl> impl;
62  };
63 }
Definition: clanapp.h:35
std::function< void()> & func_expired()
Callback invoked every time the timer interval occurs.
Timer()
Creates a timer object.
unsigned int get_timeout() const
Returns the current timeout. In milliseconds.
void stop()
Stop the timer.
void start(unsigned int timeout, bool repeat=true)
Starts the timer. Timeout in milliseconds.
Timer class that invokes a callback on a specified interval.
Definition: timer.h:39
bool is_repeating() const
Returns true if the timer repeats until it is stopped.