/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019, Google Inc.
*
* File descriptor event notifier
*/
#include <libcamera/base/event_notifier.h>
#include <libcamera/base/event_dispatcher.h>
#include <libcamera/base/log.h>
#include <libcamera/base/message.h>
#include <libcamera/base/thread.h>
#include <libcamera/camera_manager.h>
/**
* \file event_notifier.h
* \brief File descriptor event notifier
*/
namespace libcamera {
LOG_DECLARE_CATEGORY(Event)
/**
* \class EventNotifier
* \brief Notify of activity on a file descriptor
*
* The EventNotifier models a file descriptor event source that can be
* monitored. It is created with the file descriptor to be monitored and the
* type of event, and is enabled by default. It will emit the \ref activated
* signal whenever an event of the monitored type occurs on the file descriptor.
*
* Supported type of events are EventNotifier::Read, EventNotifier::Write and
* EventNotifier::Exception. The type is specified when constructing the
* notifier, and can be retrieved using the type() function. To listen to
* multiple event types on the same file descriptor multiple notifiers must be
* created.
*
* The notifier can be disabled with the setEnabled() function. When the notifier
* is disabled it ignores events and does not emit the \ref activated signal.
* The notifier can then be re-enabled with the setEnabled() function.
*
* Creating multiple notifiers of the same type for the same file descriptor is
* not allowed and results in undefined behaviour.
*
* Notifier events are detected and dispatched from the
* EventDispatcher::processEvents() function.
*/
/**
* \enum EventNotifier::Type
* Type of file descriptor event to listen for.
* \var EventNotifier::Read
* Data is available to be read from the file descriptor
* \var EventNotifier::Write
* Data can be written to the file descriptor
* \var EventNotifier::Exception
* An exception has occurred on the file descriptor
*/
/**
* \brief Construct an event notifier with a file descriptor and event type
* \param[in] fd The file descriptor to monitor
* \param[in] type The event type to monitor
* \param[in] parent The parent Object
*/
EventNotifier::EventNotifier(int fd, Type type, Object *parent)
: Object(parent), fd_(fd), type_(type), enabled_(false)
{
setEnabled(true);
}
EventNotifier::~EventNotifier()
{
setEnabled(false);
}
/**
* \fn EventNotifier::type()
* \brief Retrieve the type of the event being monitored
* \return The type of the event
*/
/**
* \fn EventNotifier::fd()
* \brief Retrieve the file descriptor being monitored
* \return The file descriptor
*/
/**
* \fn EventNotifier::enabled()
* \brief Retrieve the notifier state
* \return True if the notifier is enabled, or false otherwise
* \sa setEnabled()
*/
/**
* \brief Enable or disable the notifier
* \param[in] enable True to enable the notifier, false to disable it
*
* This function enables or disables the notifier. A disabled notifier ignores
* events and does not emit the \ref activated signal.
*
* \context This function is \threadbound.
*/
void EventNotifier::setEnabled(bool enable)
{
if (!assertThreadBound("EventNotifier can't be enabled from another thread"))
return;
if (enabled_ == enable)
return;
enabled_ = enable;
EventDispatcher *dispatcher = thread()->eventDispatcher();
if (enable)
dispatcher->registerEventNotifier(this);
else
dispatcher->unregisterEventNotifier(this);
}
/**
* \var EventNotifier::activated
* \brief Signal emitted when the event occurs
*
* This signal is emitted when the event \ref type() occurs on the file
* descriptor monitored by the notifier. The notifier pointer is passed as a
* parameter.
*/
void EventNotifier::message(Message *msg)
{
if (msg->type() == Message::ThreadMoveMessage) {
if (enabled_) {
setEnabled(false);
invokeMethod(&EventNotifier::setEnabled,
ConnectionTypeQueued, true);
}
}
Object::message(msg);
}
} /* namespace libcamera */
href='#n22'>22</a>
<a id='n23' href='#n23'>23</a>
<a id='n24' href='#n24'>24</a>
<a id='n25' href='#n25'>25</a>
<a id='n26' href='#n26'>26</a>
<a id='n27' href='#n27'>27</a>
<a id='n28' href='#n28'>28</a>
<a id='n29' href='#n29'>29</a>
<a id='n30' href='#n30'>30</a>
</pre></td>
<td class='lines'><pre><code><span class="hl com">/* SPDX-License-Identifier: BSD-2-Clause */</span>
<span class="hl com">/*</span>
<span class="hl com"> * Copyright (C) 2019-2020, Raspberry Pi (Trading) Limited</span>
<span class="hl com"> *</span>
<span class="hl com"> * logging.hpp - logging macros</span>
<span class="hl com"> */</span>
<span class="hl ppc">#pragma once</span>
<span class="hl ppc">#include <iostream></span>
<span class="hl ppc">#ifndef RPI_LOGGING_ENABLE</span>
<span class="hl ppc">#define RPI_LOGGING_ENABLE 0</span>
<span class="hl ppc">#endif</span>
<span class="hl ppc">#ifndef RPI_WARNING_ENABLE</span>
<span class="hl ppc">#define RPI_WARNING_ENABLE 1</span>
<span class="hl ppc">#endif</span>
<span class="hl ppc">#define RPI_LOG(stuff) \</span>
<span class="hl ppc"> do { \</span>
<span class="hl ppc"> if (RPI_LOGGING_ENABLE) \</span>
<span class="hl ppc"> std::cout << __FUNCTION__ <<</span> <span class="hl pps">": "</span><span class="hl ppc"> << stuff <<</span> <span class="hl pps">"</span><span class="hl esc">\n</span><span class="hl pps">"</span><span class="hl ppc">; \</span>
<span class="hl ppc"> } while (0)</span>
<span class="hl ppc">#define RPI_WARN(stuff) \</span>
<span class="hl ppc"> do { \</span>
<span class="hl ppc"> if (RPI_WARNING_ENABLE) \</span>
<span class="hl ppc"> std::cout << __FUNCTION__ <<</span> <span class="hl pps">" ***WARNING*** "</span><span class="hl ppc"> \</span>
<span class="hl ppc"> << stuff <<</span> <span class="hl pps">"</span><span class="hl esc">\n</span><span class="hl pps">"</span><span class="hl ppc">; \</span>
<span class="hl ppc"> } while (0)</span>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.zx2c4.com/cgit/about/'>cgit v1.2.1</a> (<a href='https://git-scm.com/'>git 2.18.0</a>) at 2025-05-09 00:56:08 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>