hopper.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/type_traits.hxx>
 
#include <condition_variable>
#include <cstddef>
#include <memory>
#include <utility>
 
namespace StormByte::Buffer {
    template<Type::MoveConstructible T> class Sink;
 
    template<Type::MoveConstructible T>
    class Hopper {
        public:
            Hopper() noexcept;
 
            explicit Hopper(std::size_t capacity) noexcept;
 
            Hopper(const Hopper&) = delete;
 
            Hopper(Hopper&&) noexcept = delete;
 
            ~Hopper() noexcept;
 
            Hopper& operator=(const Hopper&) = delete;
 
            Hopper& operator=(Hopper&&) noexcept = delete;
 
            std::size_t Capacity() const noexcept;
 
            void Capacity(std::size_t capacity) noexcept;
 
            std::size_t Size() const noexcept;
 
            bool Full() const noexcept;
 
            void Push(T item) noexcept;
 
            Hopper& operator<<(T item) noexcept;
 
            void Eof() noexcept;
 
            T Pop() noexcept;
 
            Hopper& operator>>(T& item) noexcept;
 
            bool EoF() const noexcept;
 
            bool Empty() const noexcept;
 
            void Notify(std::condition_variable& wake) noexcept;
 
            void Unnotify() noexcept;
 
            friend Hopper& operator>>(T& item, Hopper& hopper) noexcept {
                hopper << std::move(item);
                return hopper;
            }
 
            friend Hopper& operator>>(T&& item, Hopper& hopper) noexcept {
                hopper << std::move(item);
                return hopper;
            }
 
        private:
            friend class Sink<T>;
 
            void AddWriter() noexcept;
            void CloseWriter() noexcept;
 
            class Implementation;
 
            std::unique_ptr<Implementation> m_impl; 
    };
}
 
#include <StormByte/buffer/hopper.txx>