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
|
/*
* Copyright (c) 2010 Remko Tronçon
* Licensed under the GNU General Public License v3.
* See Documentation/Licenses/GPLv3.txt for more information.
*/
#pragma once
#include <Swiften/Base/boost_bsignals.h>
#include <Swiften/Base/API.h>
namespace Swift {
/**
* A class for triggering an event after a given period.
*/
class SWIFTEN_API Timer {
public:
typedef boost::shared_ptr<Timer> ref;
virtual ~Timer();
/**
* Starts the timer.
*
* After the given period, onTick() will be called.
*/
virtual void start() = 0;
/**
* Cancels the timer.
*
* If the timer was started, onTick() will no longer be called.
*/
virtual void stop() = 0;
/**
* Emitted when the timer expires.
*/
boost::signal<void ()> onTick;
};
}
|
