libcamera: include/libcamera/base/timer.h Source File

libcamera v0.0.4 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
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 * timer.h - Generic timer
6 */
7
8#pragma once
9
10#include <chrono>
11#include <stdint.h>
12
13#include <libcamera/base/private.h>
14
15#include <libcamera/base/object.h>
16#include <libcamera/base/signal.h>
17
18namespace libcamera {
19
20class Message;
21
22 class Timer : public Object
23{
24public:
25 Timer(Object *parent = nullptr);
26 ~Timer();
27
28 void start(std::chrono::milliseconds duration);
29 void start(std::chrono::steady_clock::time_point deadline);
30 void stop();
31 bool isRunning() const;
32
33 std::chrono::steady_clock::time_point deadline() const { return deadline_; }
34
35 Signal<> timeout;
36
37protected:
38 void message(Message *msg) override;
39
40private:
41 void registerTimer();
42 void unregisterTimer();
43
44 bool running_;
45 std::chrono::steady_clock::time_point deadline_;
46};
47
48} /* namespace libcamera */
libcamera::Message
A message that can be posted to a Thread.
Definition: message.h:24
libcamera::Object
Base object to support automatic signal disconnection.
Definition: object.h:25
libcamera::Object::parent
Object * parent() const
Retrieve the object's parent.
Definition: object.h:47
libcamera::Signal
Generic signal and slot communication mechanism.
Definition: signal.h:39
libcamera::Timer
Single-shot timer interface.
Definition: timer.h:23
libcamera::Timer::isRunning
bool isRunning() const
Check if the timer is running.
Definition: timer.cpp:144
libcamera::Timer::message
void message(Message *msg) override
Message handler for the object.
Definition: timer.cpp:162
libcamera::Timer::deadline
std::chrono::steady_clock::time_point deadline() const
Retrieve the timer deadline.
Definition: timer.h:33
libcamera::Timer::start
void start(std::chrono::milliseconds duration)
Start or restart the timer with a timeout of duration.
Definition: timer.cpp:73
libcamera::Timer::stop
void stop()
Stop the timer.
Definition: timer.cpp:115
libcamera::Timer::timeout
Signal timeout
Signal emitted when the timer times out.
Definition: timer.h:35
libcamera
Top-level libcamera namespace.
Definition: backtrace.h:17
object.h
Base object to support automatic signal disconnection.
signal.h
Signal & slot implementation.