626172a16b
Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.
Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
111 lines
3.2 KiB
C++
111 lines
3.2 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* Method bind and invocation
|
|
*/
|
|
|
|
#include <libcamera/base/bound_method.h>
|
|
#include <libcamera/base/message.h>
|
|
#include <libcamera/base/object.h>
|
|
#include <libcamera/base/semaphore.h>
|
|
#include <libcamera/base/thread.h>
|
|
|
|
/**
|
|
* \file base/bound_method.h
|
|
* \brief Method bind and invocation
|
|
*/
|
|
|
|
namespace libcamera {
|
|
|
|
/**
|
|
* \enum ConnectionType
|
|
* \brief Connection type for asynchronous communication
|
|
*
|
|
* This enumeration describes the possible types of asynchronous communication
|
|
* between a sender and a receiver. It applies to Signal::emit() and
|
|
* Object::invokeMethod().
|
|
*
|
|
* \var ConnectionTypeAuto
|
|
* \brief If the sender and the receiver live in the same thread,
|
|
* ConnectionTypeDirect is used. Otherwise ConnectionTypeQueued is used.
|
|
*
|
|
* \var ConnectionTypeDirect
|
|
* \brief The receiver is invoked immediately and synchronously in the sender's
|
|
* thread.
|
|
*
|
|
* \var ConnectionTypeQueued
|
|
* \brief The receiver is invoked asynchronously
|
|
*
|
|
* Invoke the receiver asynchronously in its thread when control returns to the
|
|
* thread's event loop. The sender proceeds without waiting for the invocation
|
|
* to complete.
|
|
*
|
|
* \var ConnectionTypeBlocking
|
|
* \brief The receiver is invoked synchronously
|
|
*
|
|
* If the sender and the receiver live in the same thread, this is equivalent to
|
|
* ConnectionTypeDirect. Otherwise, the receiver is invoked asynchronously in
|
|
* its thread when control returns to the thread's event loop. The sender
|
|
* blocks until the receiver signals the completion of the invocation.
|
|
*/
|
|
|
|
/**
|
|
* \brief Invoke the bound method with packed arguments
|
|
* \param[in] pack Packed arguments
|
|
* \param[in] deleteMethod True to delete \a this bound method instance when
|
|
* method invocation completes
|
|
*
|
|
* The bound method stores its return value, if any, in the arguments \a pack.
|
|
* For direct and blocking invocations, this is performed synchronously, and
|
|
* the return value contained in the pack may be used. For queued invocations,
|
|
* the return value is stored at an undefined point of time and shall thus not
|
|
* be used by the caller.
|
|
*
|
|
* \return True if the return value contained in the \a pack may be used by the
|
|
* caller, false otherwise
|
|
*/
|
|
bool BoundMethodBase::activatePack(std::shared_ptr<BoundMethodPackBase> pack,
|
|
bool deleteMethod)
|
|
{
|
|
ConnectionType type = connectionType_;
|
|
if (type == ConnectionTypeAuto) {
|
|
if (Thread::current() == object_->thread())
|
|
type = ConnectionTypeDirect;
|
|
else
|
|
type = ConnectionTypeQueued;
|
|
} else if (type == ConnectionTypeBlocking) {
|
|
if (Thread::current() == object_->thread())
|
|
type = ConnectionTypeDirect;
|
|
}
|
|
|
|
switch (type) {
|
|
case ConnectionTypeDirect:
|
|
default:
|
|
invokePack(pack.get());
|
|
if (deleteMethod)
|
|
delete this;
|
|
return true;
|
|
|
|
case ConnectionTypeQueued: {
|
|
std::unique_ptr<Message> msg =
|
|
std::make_unique<InvokeMessage>(this, pack, nullptr, deleteMethod);
|
|
object_->postMessage(std::move(msg));
|
|
return false;
|
|
}
|
|
|
|
case ConnectionTypeBlocking: {
|
|
Semaphore semaphore;
|
|
|
|
std::unique_ptr<Message> msg =
|
|
std::make_unique<InvokeMessage>(this, pack, &semaphore, deleteMethod);
|
|
object_->postMessage(std::move(msg));
|
|
|
|
semaphore.acquire();
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
} /* namespace libcamera */
|