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);
36
37public:
38 static NonnullRefPtr<Timer> create_single_shot(int interval, Function<void()>&& timeout_handler, Object* parent = nullptr)
39 {
40 auto timer = adopt(*new Timer(interval, move(timeout_handler), parent));
41 timer->set_single_shot(true);
42 return timer;
43 }
44
45 virtual ~Timer() override;
46
47 void start();
48 void start(int interval);
49 void restart(int interval);
50 void stop();
51
52 bool is_active() const { return m_active; }
53 int interval() const { return m_interval; }
54 void set_interval(int interval)
55 {
56 if (m_interval == interval)
57 return;
58 m_interval = interval;
59 m_interval_dirty = true;
60 }
61
62 bool is_single_shot() const { return m_single_shot; }
63 void set_single_shot(bool single_shot) { m_single_shot = single_shot; }
64
65 Function<void()> on_timeout;
66
67private:
68 explicit Timer(Object* parent = nullptr);
69 Timer(int interval, Function<void()>&& timeout_handler, Object* parent = nullptr);
70
71 virtual void timer_event(TimerEvent&) override;
72
73 bool m_active { false };
74 bool m_single_shot { false };
75 bool m_interval_dirty { false };
76 int m_interval { 0 };
77};
78
79}