jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Function.h>
30#include <LibCore/Object.h>
31
32namespace Core {
33
34class Timer final : public Object {
35 C_OBJECT(Timer)
36public:
37 virtual ~Timer() override;
38
39 void start();
40 void start(int interval);
41 void restart(int interval);
42 void stop();
43
44 bool is_active() const { return m_active; }
45 int interval() const { return m_interval; }
46 void set_interval(int interval)
47 {
48 if (m_interval == interval)
49 return;
50 m_interval = interval;
51 m_interval_dirty = true;
52 }
53
54 bool is_single_shot() const { return m_single_shot; }
55 void set_single_shot(bool single_shot) { m_single_shot = single_shot; }
56
57 Function<void()> on_timeout;
58
59private:
60 explicit Timer(Object* parent = nullptr);
61 Timer(int interval, Function<void()>&& timeout_handler, Object* parent = nullptr);
62
63 virtual void timer_event(TimerEvent&) override;
64
65 bool m_active { false };
66 bool m_single_shot { false };
67 bool m_interval_dirty { false };
68 int m_interval { 0 };
69};
70
71}