pipeline.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Buffer.
 *
 * StormByte-Buffer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * StormByte-Buffer 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
 * along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
#include <StormByte/buffer/consumer.hxx>
#include <StormByte/buffer/external.hxx>
#include <StormByte/buffer/producer.hxx>
#include <StormByte/buffer/typedefs.hxx>
 
#include <functional>
#include <memory>
#include <thread>
#include <vector>
 
namespace StormByte::Buffer {
    class LockFreeRing;
 
    class STORMBYTE_BUFFER_PUBLIC Pipeline final {
        public:
            using PipeFunction = std::function<void(
                ExternalReader&,
                ExternalWriter&,
                std::shared_ptr<Logger::Log>
            )>;
 
            Pipeline() noexcept;
 
            Pipeline(const Pipeline& other);
 
            Pipeline(Pipeline&& other) noexcept;
 
            ~Pipeline() noexcept;
 
            Pipeline& operator=(const Pipeline& other);
 
            Pipeline& operator=(Pipeline&& other) noexcept;
 
            void AddPipe(const PipeFunction& pipe);
 
            void AddPipe(PipeFunction&& pipe);
 
            void SetError() const noexcept;
 
            Consumer Process(Consumer buffer,
                            const ExecutionMode& mode,
                            std::shared_ptr<Logger::Log> log) const noexcept;
 
        private:
            struct Impl;                    
            std::unique_ptr<Impl> m_impl;   
    };
}