diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 11:36:04 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 11:36:04 +0000 |
commit | 040eee1aa49b49df4698d83a05af57c220127fd1 (patch) | |
tree | f635435954e6ccde5eee9893889e24f30ca68346 /src/lib/asiolink/io_service_signal.h | |
parent | Initial commit. (diff) | |
download | isc-kea-upstream.tar.xz isc-kea-upstream.zip |
Adding upstream version 2.2.0.upstream/2.2.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/lib/asiolink/io_service_signal.h')
-rw-r--r-- | src/lib/asiolink/io_service_signal.h | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/src/lib/asiolink/io_service_signal.h b/src/lib/asiolink/io_service_signal.h new file mode 100644 index 0000000..b078ce4 --- /dev/null +++ b/src/lib/asiolink/io_service_signal.h @@ -0,0 +1,60 @@ +// Copyright (C) 2020-2021 Internet Systems Consortium, Inc. ("ISC") +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at http://mozilla.org/MPL/2.0/. + +#ifndef IO_SERVICE_SIGNAL_H +#define IO_SERVICE_SIGNAL_H + +#include <asiolink/io_service.h> + +#include <boost/shared_ptr.hpp> + +namespace isc { +namespace asiolink { + +/// @brief Defines a handler function for an IOSignal. +typedef std::function<void(int signum)> IOSignalHandler; + +class IOSignalSetImpl; + +/// @brief Implements an asynchronous "signal" for IOService driven processing +/// +/// This class allows a OS signal such as SIGHUP to propagated to an IOService +/// as a ready event with a callback using boost ASIO. +class IOSignalSet { +public: + /// @brief Constructor. + /// + /// @param io_service IOService to which to send the signal. + /// @param handler Handler to call when a signal is received. + IOSignalSet(asiolink::IOServicePtr io_service, IOSignalHandler handler); + + /// @brief Destructor. + ~IOSignalSet() = default; + + /// @brief Add a signal to the list of signals to handle. + /// + /// @param signum Signal number. + /// @throw Unexpected on error. + void add(int signum); + + /// @brief Remove a signal from the list of signals to handle. + /// + /// @param signum Signal number. + /// @throw Unexpected on error. + void remove(int signum); + +private: + /// @brief Pointer to the implementation. + boost::shared_ptr<IOSignalSetImpl> impl_; +}; + +/// @brief Defines a pointer to an IOSignalSet. +typedef boost::shared_ptr<IOSignalSet> IOSignalSetPtr; + +} // namespace asiolink +} // namespace isc + +#endif // IO_SERVICE_SIGNAL_H |