libcamera  v0.0.0
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 #ifndef __LIBCAMERA_INTERNAL_THREAD_H__
8 #define __LIBCAMERA_INTERNAL_THREAD_H__
9 
10 #include <memory>
11 #include <mutex>
12 #include <sys/types.h>
13 #include <thread>
14 
15 #include <libcamera/signal.h>
16 
18 
19 namespace libcamera {
20 
21 class EventDispatcher;
22 class Message;
23 class Object;
24 class ThreadData;
25 class ThreadMain;
26 
27 using Mutex = std::mutex;
28 using MutexLocker = std::unique_lock<std::mutex>;
29 
30 class Thread
31 {
32 public:
33  Thread();
34  virtual ~Thread();
35 
36  void start();
37  void exit(int code = 0);
38  bool wait(utils::duration duration = utils::duration::max());
39 
40  bool isRunning();
41 
43 
44  static Thread *current();
45  static pid_t currentId();
46 
48  void setEventDispatcher(std::unique_ptr<EventDispatcher> dispatcher);
49 
50  void dispatchMessages();
51 
52 protected:
53  int exec();
54  virtual void run();
55 
56 private:
57  void startThread();
58  void finishThread();
59 
60  void postMessage(std::unique_ptr<Message> msg, Object *receiver);
61  void removeMessages(Object *receiver);
62 
63  friend class Object;
64  friend class ThreadData;
65  friend class ThreadMain;
66 
67  void moveObject(Object *object);
68  void moveObject(Object *object, ThreadData *currentData,
69  ThreadData *targetData);
70 
71  std::thread thread_;
72  ThreadData *data_;
73 };
74 
75 } /* namespace libcamera */
76 
77 #endif /* __LIBCAMERA_INTERNAL_THREAD_H__ */
Interface to manage the libcamera events and timers.
Definition: event_dispatcher.h:18
Base object to support automatic signal disconnection.
Definition: object.h:25
Generic signal and slot communication mechanism.
Definition: signal.h:39
Thread-local internal data.
Definition: thread.cpp:138
Thread wrapper for the main thread.
Definition: thread.cpp:170
A thread of execution.
Definition: thread.h:31
static Thread * current()
Retrieve the Thread instance for the current thread.
Definition: thread.cpp:419
static pid_t currentId()
Retrieve the ID of the current thread.
Definition: thread.cpp:433
EventDispatcher * eventDispatcher()
Retrieve the event dispatcher.
Definition: thread.cpp:474
void dispatchMessages()
Dispatch all posted messages for this thread.
Definition: thread.cpp:557
int exec()
Enter the event loop.
Definition: thread.cpp:301
void exit(int code=0)
Stop the thread's event loop.
Definition: thread.cpp:352
void setEventDispatcher(std::unique_ptr< EventDispatcher > dispatcher)
Set the event dispatcher.
Definition: thread.cpp:452
void start()
Start the thread.
Definition: thread.cpp:249
virtual void run()
Main method of the thread.
Definition: thread.cpp:327
Signal< Thread * > finished
Signal the end of thread execution.
Definition: thread.h:42
bool wait(utils::duration duration=utils::duration::max())
Wait for the thread to finish.
Definition: thread.cpp:375
bool isRunning()
Check if the thread is running.
Definition: thread.cpp:404
Thread()
Create a thread.
Definition: thread.cpp:234
Signal & slot implementation.
std::unique_lock< std::mutex > MutexLocker
An alias for std::unique_lock<std::mutex>
Definition: thread.h:28
std::mutex Mutex
An alias for std::mutex.
Definition: thread.h:27
Miscellaneous utility functions.
std::chrono::steady_clock::duration duration
The libcamera duration related to libcamera::utils::clock.
Definition: utils.h:66