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

libcamera v0.0.4 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
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
8#pragma once
9
10#include <list>
11#include <memory>
12#include <vector>
13
14#include <libcamera/base/bound_method.h>
15
16namespace libcamera {
17
18class Message;
19template<typename... Args>
20class Signal;
21class SignalBase;
22class Thread;
23
24 class Object
25{
26public:
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 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
49protected:
50 virtual void message(Message *msg);
51
52private:
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 */
bound_method.h
Method bind and invocation.
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::invokeMethod
R invokeMethod(R(T::*func)(FuncArgs...), ConnectionType type, Args &&... args)
Invoke a method asynchronously on an Object instance.
Definition: object.h:36
libcamera::Object::parent
Object * parent() const
Retrieve the object's parent.
Definition: object.h:47
libcamera::Object::message
virtual void message(Message *msg)
Message handler for the object.
Definition: object.cpp:188
libcamera::Object::deleteLater
void deleteLater()
Schedule deletion of the instance in the thread it belongs to.
Definition: object.cpp:147
libcamera::Object::moveToThread
void moveToThread(Thread *thread)
Move the object and all its children to a different thread.
Definition: object.cpp:264
libcamera::Object::thread
Thread * thread() const
Retrieve the thread the object is bound to.
Definition: object.h:44
libcamera::Object::~Object
virtual ~Object()
Destroy an Object instance.
Definition: object.cpp:88
libcamera::Object::postMessage
void postMessage(std::unique_ptr< Message > msg)
Post a message to the object's thread.
Definition: object.cpp:171
libcamera::Thread
A thread of execution.
Definition: thread.h:29
libcamera
Top-level libcamera namespace.
Definition: backtrace.h:17
libcamera::ConnectionType
ConnectionType
Connection type for asynchronous communication.
Definition: bound_method.h:19