libcamera  v0.0.0+100-debian/0_git20200629+e7aa92a-8-9-g77f5237c-dirty (2021-05-05T16:20:29+01:00)
Supporting cameras in Linux since 2019
object.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  * object.h - Base object
6  */
7 #ifndef __LIBCAMERA_OBJECT_H__
8 #define __LIBCAMERA_OBJECT_H__
9 
10 #include <list>
11 #include <memory>
12 #include <vector>
13 
14 #include <libcamera/bound_method.h>
15 
16 namespace libcamera {
17 
18 class Message;
19 template<typename... Args>
20 class Signal;
21 class SignalBase;
22 class Thread;
23 
24 class Object
25 {
26 public:
27  Object(Object *parent = nullptr);
28  virtual ~Object();
29 
30  void deleteLater();
31 
32  void postMessage(std::unique_ptr<Message> msg);
33 
34  template<typename T, typename R, typename... FuncArgs, typename... Args,
35  typename std::enable_if_t<std::is_base_of<Object, T>::value> * = nullptr>
36  R invokeMethod(R (T::*func)(FuncArgs...), ConnectionType type,
37  Args... args)
38  {
39  T *obj = static_cast<T *>(this);
40  auto *method = new BoundMethodMember<T, R, FuncArgs...>(obj, this, func, type);
41  return method->activate(args..., true);
42  }
43 
44  Thread *thread() const { return thread_; }
45  void moveToThread(Thread *thread);
46 
47  Object *parent() const { return parent_; }
48 
49 protected:
50  virtual void message(Message *msg);
51 
52 private:
53  friend class SignalBase;
54  friend class Thread;
55 
56  void notifyThreadMove();
57 
58  void connect(SignalBase *signal);
59  void disconnect(SignalBase *signal);
60 
61  Object *parent_;
62  std::vector<Object *> children_;
63 
64  Thread *thread_;
65  std::list<SignalBase *> signals_;
66  unsigned int pendingMessages_;
67 };
68 
69 } /* namespace libcamera */
70 
71 #endif /* __LIBCAMERA_OBJECT_H__ */
ConnectionType
Connection type for asynchronous communication.
Definition: bound_method.h:19
Top-level libcamera namespace.
Definition: bound_method.h:15
A thread of execution.
Definition: thread.h:31
Object(Object *parent=nullptr)
Construct an Object instance.
Definition: object.cpp:61
virtual ~Object()
Destroy an Object instance.
Definition: object.cpp:81
A message that can be posted to a Thread.
Definition: message.h:21
R invokeMethod(R(T::*func)(FuncArgs...), ConnectionType type, Args... args)
Invoke a method asynchronously on an Object instance.
Definition: object.h:36
Thread * thread() const
Retrieve the thread the object is bound to.
Definition: object.h:44
Object * parent() const
Retrieve the object&#39;s parent.
Definition: object.h:47
Generic signal and slot communication mechanism.
Definition: object.h:20
virtual void message(Message *msg)
Message handler for the object.
Definition: object.cpp:177
Base object to support automatic signal disconnection.
Definition: object.h:24
Method bind and invocation.
void deleteLater()
Schedule deletion of the instance in the thread it belongs to.
Definition: object.cpp:140
void moveToThread(Thread *thread)
Move the object and all its children to a different thread.
Definition: object.cpp:245
void postMessage(std::unique_ptr< Message > msg)
Post a message to the object&#39;s thread.
Definition: object.cpp:160