0
0
mirror of https://github.com/OpenVPN/openvpn3.git synced 2024-09-19 19:52:15 +02:00
openvpn3/openvpn/asio/asiocontext.hpp
Razvan Cojocaru 4b10dc453a Add AsioContextStore::stop()
This is meant to help with the following scenario: main thread
creates secondary threads, each secondary thread asks the context
store for its own context, then goes into a "forever" scheduling
loop. Main thread waits for the secondary threads to finish, and
owns the context store. It would be nice to be able to have yet
another thread (say, a SIGINT handler) be able to call .stop()
on all the contexts managed by the context store, thus being able
to end the loops in the secondary threads and allow the main
thread to exit.

Signed-off-by: Razvan Cojocaru <razvan.cojocaru@openvpn.com>
2024-05-22 16:19:13 +00:00

65 lines
2.0 KiB
C++

// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012-2022 OpenVPN Inc.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License Version 3
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program in the COPYING file.
// If not, see <http://www.gnu.org/licenses/>.
#ifndef OPENVPN_ASIO_ASIOCONTEXT_H
#define OPENVPN_ASIO_ASIOCONTEXT_H
#include <vector>
#include <memory>
#include <mutex>
#include <openvpn/io/io.hpp>
namespace openvpn {
class AsioContextStore
{
public:
openvpn_io::io_context &new_context(int concurrency_hint)
{
openvpn_io::io_context *ioc = new openvpn_io::io_context(concurrency_hint);
{
std::lock_guard lock(mutex);
contexts.emplace_back(ioc);
}
return *ioc;
}
/**
* This is to be used only as a last resort. The proper way to end an
* io_context-driven thread is to simply stop scheduling work on the reactor
* and exit gracefully. DO NOT USE THIS IF THERE'S AN ALTERNATIVE!
*/
void stop()
{
std::lock_guard lock(mutex);
for (auto &context : contexts)
context->stop();
}
private:
std::mutex mutex;
std::vector<std::unique_ptr<openvpn_io::io_context>> contexts;
};
} // namespace openvpn
#endif