1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
// 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- OpenVPN Inc.
//
// SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
#pragma once
// Define this parameter before including this header:
// OPENVPN_LOG_CLASS -- client class that exposes a log() method
#ifndef OPENVPN_LOG_CLASS
#error OPENVPN_LOG_CLASS must be defined
#endif
namespace openvpn::Log {
#ifdef OPENVPN_LOG_GLOBAL
// OPENVPN_LOG uses global object pointer
inline OPENVPN_LOG_CLASS *global_log = nullptr; // GLOBAL
#else
// OPENVPN_LOG uses thread-local object pointer
inline thread_local OPENVPN_LOG_CLASS *global_log = nullptr; // GLOBAL
#endif
/**
* @brief Scoped RAII for the \c global_log \a pointer
*
* While in scope, \c global_log points to the instance of the class defined by
* the \c OPENVPN_LOG_CLASS macro above. When it goes out of scope, the
* \c global_log pointer is reset to \c nullptr
*/
struct Context
{
/**
* @brief Argument to construct a \c Context in a different thread
*
* The new \c Context will have the same \c global_log pointer as the current
* \c Context. Intended for the thread_local version of \c global_log
*/
class Wrapper
{
#ifndef OPENVPN_LOG_GLOBAL
public:
Wrapper()
: log(obj())
{
}
private:
friend struct Context;
OPENVPN_LOG_CLASS *log;
#endif
};
/**
* @brief construct a \c Context in a different thread
*
* @param wrap holds the value of \c global_log from the sourcing thread
*/
Context(const Wrapper &wrap)
{
#ifndef OPENVPN_LOG_GLOBAL
global_log = wrap.log;
#endif
}
/**
* @brief construct a \c Context setting the \c global_log pointer
*
* @param cli pointer to \c OPENVPN_LOG_CLASS instance
*/
Context(OPENVPN_LOG_CLASS *cli)
{
global_log = cli;
}
~Context()
{
global_log = nullptr;
}
static bool defined()
{
return global_log != nullptr;
}
static OPENVPN_LOG_CLASS *obj()
{
return global_log;
}
};
} // namespace openvpn::Log
|