libcamera  v0.2.0+85-1c5830a9
Supporting cameras in Linux since 2019
thread.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  * thread.h - Thread support
6  */
7 
8 #pragma once
9 
10 #include <memory>
11 #include <sys/types.h>
12 #include <thread>
13 
14 #include <libcamera/base/private.h>
15 
16 #include <libcamera/base/message.h>
17 #include <libcamera/base/signal.h>
18 #include <libcamera/base/utils.h>
19 
20 namespace libcamera {
21 
22 class EventDispatcher;
23 class Message;
24 class Object;
25 class ThreadData;
26 class ThreadMain;
27 
28 class Thread
29 {
30 public:
31  Thread();
32  virtual ~Thread();
33 
34  void start();
35  void exit(int code = 0);
36  bool wait(utils::duration duration = utils::duration::max());
37 
38  bool isRunning();
39 
41 
42  static Thread *current();
43  static pid_t currentId();
44 
46 
47  void dispatchMessages(Message::Type type = Message::Type::None);
48 
49 protected:
50  int exec();
51  virtual void run();
52 
53 private:
54  void startThread();
55  void finishThread();
56 
57  void postMessage(std::unique_ptr<Message> msg, Object *receiver);
58  void removeMessages(Object *receiver);
59 
60  friend class Object;
61  friend class ThreadData;
62  friend class ThreadMain;
63 
64  void moveObject(Object *object);
65  void moveObject(Object *object, ThreadData *currentData,
66  ThreadData *targetData);
67 
68  std::thread thread_;
69  ThreadData *data_;
70 };
71 
72 } /* namespace libcamera */
bool wait(utils::duration duration=utils::duration::max())
Wait for the thread to finish.
Definition: thread.cpp:425
static Thread * current()
Retrieve the Thread instance for the current thread.
Definition: thread.cpp:476
EventDispatcher * eventDispatcher()
Retrieve the event dispatcher.
Definition: thread.cpp:508
Top-level libcamera namespace.
Definition: backtrace.h:17
Interface to manage the libcamera events and timers.
Definition: event_dispatcher.h:19
Message queue support.
Thread-local internal data.
Definition: thread.cpp:140
A thread of execution.
Definition: thread.h:28
static pid_t currentId()
Retrieve the ID of the current thread.
Definition: thread.cpp:492
Miscellaneous utility functions.
virtual void run()
Main function of the thread.
Definition: thread.cpp:367
Signal & slot implementation.
bool isRunning()
Check if the thread is running.
Definition: thread.cpp:460
void dispatchMessages(Message::Type type=Message::Type::None)
Dispatch posted messages for this thread.
Definition: thread.cpp:609
std::chrono::steady_clock::duration duration
The libcamera duration related to libcamera::utils::clock.
Definition: utils.h:72
int exec()
Enter the event loop.
Definition: thread.cpp:333
void exit(int code=0)
Stop the thread&#39;s event loop.
Definition: thread.cpp:400
Thread()
Create a thread.
Definition: thread.cpp:266
Generic signal and slot communication mechanism.
Definition: object.h:20
Signal finished
Signal the end of thread execution.
Definition: thread.h:40
void start()
Start the thread.
Definition: thread.cpp:281
Type
The message type.
Definition: message.h:26
Base object to support automatic signal disconnection.
Definition: object.h:24
Thread wrapper for the main thread.
Definition: thread.cpp:172