libcamera  v0.3.1+12-19bbca3c
Supporting cameras in Linux since 2019
Public Member Functions | List of all members
libcamera::InvokeMessage Class Reference

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

Inheritance diagram for libcamera::InvokeMessage:
Inheritance graph
[legend]
Collaboration diagram for libcamera::InvokeMessage:
Collaboration graph
[legend]

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. More...
 
Semaphoresemaphore () const
 Retrieve the message semaphore passed to the constructor. More...
 
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. More...
 
Type type () const
 Retrieve the message type. More...
 
Objectreceiver () const
 Retrieve the message receiver. More...
 

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. More...
 

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()

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: