summaryrefslogtreecommitdiffstats
blob: 977ed8944b0780acbcfee3d71767fa252dfc9a93 (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
/*
 * Copyright (c) 2010-2016 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#pragma once

#include <boost/signals2.hpp>

#include <Swiften/Base/API.h>

namespace Swift {
    /**
     * A class for triggering an event after a given period.
     */
    class SWIFTEN_API Timer {
        public:
            typedef std::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::signals2::signal<void ()> onTick;
    };
}