sink.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/hopper.hxx>
#include <StormByte/type_traits.hxx>
 
#include <condition_variable>
#include <cstddef>
#include <functional>
#include <memory>
 
namespace StormByte::Buffer {
    template<Type::MoveConstructible T>
    class Sink {
        public:
            using Select = std::function<std::size_t(std::size_t)>;
 
            Sink() noexcept;
 
            Sink(const Sink&) = delete;
 
            Sink(Sink&&) noexcept = delete;
 
            ~Sink() noexcept;
 
            Sink& operator=(const Sink&) = delete;
 
            Sink& operator=(Sink&&) noexcept = delete;
 
            void Push(int key, T item) noexcept;
 
            void Eof() noexcept;
 
            class Lane {
                public:
                    Sink& operator>>(Sink& dest) noexcept;
 
                private:
                    friend class Sink;
                    Lane(Sink& from, int key) noexcept;
                    Sink* m_from;
                    int m_key;
            };
 
            Lane To(int key) noexcept;
 
            Sink& operator>>(Sink& dest) noexcept;
 
            Sink& operator<<(Sink& src) noexcept;
 
            Sink& operator<<(Lane lane) noexcept;
 
            [[deprecated("use producer >> consumer")]]
            void Bind(Sink& consumer);
 
            [[deprecated("use producer.To(key) >> consumer")]]
            void Bind(int key, Sink& consumer);
 
            void Drain() noexcept;
 
            bool Draining() const noexcept;
 
            void Notify(std::condition_variable& consumer) noexcept;
 
            void Unnotify() noexcept;
 
            std::size_t Capacity(int key) const noexcept;
 
            void Capacity(int key, std::size_t capacity) noexcept;
 
            std::size_t Size(int key) const noexcept;
 
            bool Full(int key) const noexcept;
 
            T Pop() noexcept;
 
            T Pop(const Select& select) noexcept;
 
            bool EoF() const noexcept;
 
            bool Ready() const noexcept;
 
        private:
            class Implementation;
 
            std::unique_ptr<Implementation> m_impl; 
    };
}
 
#include <StormByte/buffer/sink.txx>