libcamera v0.3.2
Supporting cameras in Linux since 2019
Loading...
Searching...
No Matches
libcamera::InvokeMessage Class Reference

A message carrying a method invocation across threads. More...

Inheritance diagram for libcamera::InvokeMessage:
Collaboration diagram for libcamera::InvokeMessage:

Public Member Functions

 InvokeMessage (BoundMethodBase *method, std::shared_ptr< BoundMethodPackBase > pack, Semaphore *semaphore=nullptr, bool deleteMethod=false)
 Construct an InvokeMessage for method invocation on an Object.
 
Semaphoresemaphore () const
 Retrieve the message semaphore passed to the constructor.
 
void invoke ()
 Invoke the method bound to InvokeMessage::method_ with arguments InvokeMessage::pack_.
 
- Public Member Functions inherited from libcamera::Message
 Message (Type type)
 Construct a message object of type type.
 
Type type () const
 Retrieve the message type.
 
Objectreceiver () const
 Retrieve the message receiver.
 

Additional Inherited Members

- Public Types inherited from libcamera::Message
enum  Type {
  None = 0 , InvokeMessage = 1 , ThreadMoveMessage = 2 , DeferredDelete = 3 ,
  UserMessage = 1000
}
 The message type. More...
 
- Static Public Member Functions inherited from libcamera::Message
static Type registerMessageType ()
 Reserve and register a custom user-defined message type.
 

Detailed Description

A message carrying a method invocation across threads.

Constructor & Destructor Documentation

◆ InvokeMessage()

libcamera::InvokeMessage::InvokeMessage ( BoundMethodBase * method,
std::shared_ptr< BoundMethodPackBase > pack,
Semaphore * semaphore = nullptr,
bool deleteMethod = false )

Construct an InvokeMessage for method invocation on an Object.

Parameters
[in]methodThe bound method
[in]packThe packed method arguments
[in]semaphoreThe semaphore used to signal message delivery
[in]deleteMethodTrue to delete the method when the message is destroyed

Member Function Documentation

◆ semaphore()

Semaphore * libcamera::InvokeMessage::semaphore ( ) const
inline

Retrieve the message semaphore passed to the constructor.

Returns
The message semaphore

The documentation for this class was generated from the following files: