Loading...
Searching...
No Matches
object.h
Go to the documentation of this file.
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* Base object
*/
#pragma once
#include <list>
#include <memory>
#include <utility>
#include <vector>
#include <libcamera/base/bound_method.h>
#include <libcamera/base/class.h>
namespace libcamera {
class Message;
template<typename... Args>
class Signal;
class SignalBase;
class Thread;
class Object
{
public:
Object(Object *parent = nullptr);
virtual ~Object();
void deleteLater();
void postMessage(std::unique_ptr<Message> msg);
template<typename T, typename R, typename... FuncArgs, typename... Args,
std::enable_if_t<std::is_base_of<Object, T>::value> * = nullptr>
R invokeMethod(R (T::*func)(FuncArgs...), ConnectionType type,
Args&&... args)
{
T *obj = static_cast<T *>(this);
auto *method = new BoundMethodMember<T, R, FuncArgs...>(obj, this, func, type);
return method->activate(std::forward<Args>(args)..., true);
}
Thread *thread() const { return thread_; }
void moveToThread(Thread *thread);
Object *parent() const { return parent_; }
protected:
virtual void message(Message *msg);
bool assertThreadBound(const char *message);
private:
LIBCAMERA_DISABLE_COPY_AND_MOVE(Object)
friend class SignalBase;
friend class Thread;
void notifyThreadMove();
void connect(SignalBase *signal);
void disconnect(SignalBase *signal);
Object *parent_;
std::vector<Object *> children_;
Thread *thread_;
std::list<SignalBase *> signals_;
unsigned int pendingMessages_;
};
} /* namespace libcamera */
bound_method.h
Method bind and invocation.
class.h
Utilities to help constructing class interfaces.
LIBCAMERA_DISABLE_COPY_AND_MOVE
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
Disable copy and move construction and assignment of the klass.
Definition class.h:29
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:27
libcamera::Object::Object
Object(Object *parent=nullptr)
Construct an Object instance.
Definition object.cpp:69
libcamera::Object::invokeMethod
R invokeMethod(R(T::*func)(FuncArgs...), ConnectionType type, Args &&... args)
Invoke a method asynchronously on an Object instance.
Definition object.h:38
libcamera::Object::parent
Object * parent() const
Retrieve the object's parent.
Definition object.h:49
libcamera::Object::message
virtual void message(Message *msg)
Message handler for the object.
Definition object.cpp:201
libcamera::Object::assertThreadBound
bool assertThreadBound(const char *message)
Check if the caller complies with thread-bound constraints.
Definition object.cpp:247
libcamera::Object::deleteLater
void deleteLater()
Schedule deletion of the instance in the thread it belongs to.
Definition object.cpp:160
libcamera::Object::moveToThread
void moveToThread(Thread *thread)
Move the object and all its children to a different thread.
Definition object.cpp:306
libcamera::Object::~Object
virtual ~Object()
Destroy an Object instance.
Definition object.cpp:98
libcamera::Object::thread
Thread * thread() const
Retrieve the thread the object is bound to.
Definition object.h:46
libcamera::Object::postMessage
void postMessage(std::unique_ptr< Message > msg)
Post a message to the object's thread.
Definition object.cpp:184
libcamera::Signal
Generic signal and slot communication mechanism.
Definition signal.h:39
libcamera::Thread
A thread of execution.
Definition thread.h:32
libcamera
Top-level libcamera namespace.
Definition backtrace.h:17
libcamera::ConnectionType
ConnectionType
Connection type for asynchronous communication.
Definition bound_method.h:19