threaded_log.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Logger.
 *
 * StormByte-Logger original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Logger source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-String tree and
 * the StormByte Base tree it vendors), which remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Logger 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Logger. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/logger/log.hxx>
#include <StormByte/thread_lock.hxx>
 
#include <memory>
#include <ostream>
#include <span>
#include <string_view>
 
namespace StormByte::Logger {
    class STORMBYTE_LOGGER_PUBLIC ThreadedLog : public Log {
        public:
            ThreadedLog(std::ostream& out, const Level& level = Level::Info, std::string_view format = "[%L] %T")
                : ThreadedLog(&OStreamWrite, &OStreamManip, &out, level, format) {}
 
            ThreadedLog(const ThreadedLog&) = default;
 
            ThreadedLog(ThreadedLog&&) noexcept = default;
 
            ~ThreadedLog() noexcept override;
 
            ThreadedLog& operator=(const ThreadedLog&);
 
            ThreadedLog& operator=(ThreadedLog&&) noexcept;
 
            Log& Color(const Level& level, const StormByte::Logger::Color& color) override;
 
            StormByte::Logger::Color Color(const Level& level) const override;
 
            Log& Color(std::string_view component, const Level& level, const StormByte::Logger::Color& color) override;
 
            StormByte::Logger::Color Color(std::string_view component, const Level& level) const override;
 
            Log& Format(std::string_view format) override;
 
            StormByte::String::String Format() const override;
 
            Log& Format(std::string_view component, std::string_view format) override;
 
            StormByte::String::String Format(std::string_view component) const override;
 
            Log& Throttle(const ThrottleSpec& spec) override;
 
            Log& NoThrottle(const ThrottleSpec& spec) override;
 
            Log& Throttle(double rate, std::size_t burst) override;
 
            Log& Throttle(double rate, std::size_t burst, ThrottlePolicy policy, std::size_t value, std::size_t period = 0) override;
 
            Log& Throttle(const Level& level, double rate, std::size_t burst) override;
 
            Log& Throttle(GroupManip group, double rate, std::size_t burst) override;
 
            Log& Throttle(ComponentManip component, double rate, std::size_t burst) override;
 
            Log& Throttle(ComponentManip component, const Level& level, GroupManip group, double rate, std::size_t burst, ThrottlePolicy policy = ThrottlePolicy::Drop, std::size_t value = 0, std::size_t period = 0) override;
 
            Log& NoThrottle() override;
 
            Log& NoThrottle(const Level& level) override;
 
            Log& NoThrottle(GroupManip group) override;
 
            Log& NoThrottle(ComponentManip component) override;
 
            Log& NoThrottle(ComponentManip component, const Level& level, GroupManip group) override;
 
            Log& FlushThrottle() override;
 
            Log& FlushThrottle(const ThrottleSpec& spec) override;
 
        protected:
            PointerType Clone() const override;
 
            PointerType Move() override;
 
            bool BeginPayload() override;
 
            void Write(std::wstring_view v) override;
 
            void Write(const wchar_t* v) override;
 
            void Write(std::span<const std::byte> v) override;
 
            void Write(const Level& level) override;
 
            void Write(std::ostream& (*manip)(std::ostream&)) override;
 
            void Write(Log& (*manip)(Log&) noexcept) override;
 
            void Write(RedactManip m) override;
 
            void Write(HexManip m) override;
 
            void Write(NoHexManip m) override;
 
            void Write(ColorManip manip) override;
 
            void Write(NoColorManip manip) override;
 
            void Write(FormatManip manip) override;
 
            void Write(PopFormatManip manip) override;
 
        protected:
            ThreadedLog(SinkWrite write, SinkManip manip, void* context, const Level& level, std::string_view format);
 
        private:
            std::shared_ptr<ThreadLock> m_lock; 
    };
}