libcamera  v0.3.2+116-83c5ad0f
Supporting cameras in Linux since 2019
timer.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 /*
3  * Copyright (C) 2019, Google Inc.
4  *
5  * Generic timer
6  */
7 
8 #pragma once
9 
10 #include <chrono>
11 
12 #include <libcamera/base/private.h>
13 
14 #include <libcamera/base/object.h>
15 #include <libcamera/base/signal.h>
16 
17 namespace libcamera {
18 
19 class Message;
20 
21 class Timer : public Object
22 {
23 public:
24  Timer(Object *parent = nullptr);
25  ~Timer();
26 
27  void start(std::chrono::milliseconds duration);
28  void start(std::chrono::steady_clock::time_point deadline);
29  void stop();
30  bool isRunning() const;
31 
32  std::chrono::steady_clock::time_point deadline() const { return deadline_; }
33 
35 
36 protected:
37  void message(Message *msg) override;
38 
39 private:
40  void registerTimer();
41  void unregisterTimer();
42 
43  bool running_;
44  std::chrono::steady_clock::time_point deadline_;
45 };
46 
47 } /* namespace libcamera */
void message(Message *msg) override
Message handler for the object.
Definition: timer.cpp:158
Top-level libcamera namespace.
Definition: backtrace.h:17
void stop()
Stop the timer.
Definition: timer.cpp:113
void start(std::chrono::milliseconds duration)
Start or restart the timer with a timeout of duration.
Definition: timer.cpp:73
Signal & slot implementation.
Single-shot timer interface.
Definition: timer.h:21
A message that can be posted to a Thread.
Definition: message.h:23
Timer(Object *parent=nullptr)
Construct a timer.
Definition: timer.cpp:55
Base object to support automatic signal disconnection.
Object * parent() const
Retrieve the object&#39;s parent.
Definition: object.h:47
Generic signal and slot communication mechanism.
Definition: object.h:20
Signal timeout
Signal emitted when the timer times out.
Definition: timer.h:34
Base object to support automatic signal disconnection.
Definition: object.h:24
std::chrono::steady_clock::time_point deadline() const
Retrieve the timer deadline.
Definition: timer.h:32
bool isRunning() const
Check if the timer is running.
Definition: timer.cpp:140