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 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-Buffer 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-Logger tree and
 * the rest of the StormByte suite 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-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
 * version 3 along with StormByte-Buffer. 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/size.hxx>
#include <StormByte/type_traits.hxx>
 
#include <concepts>
#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(StormByte::Size capacity) noexcept;
 
            Hopper(const Hopper&) = delete;
 
            Hopper(Hopper&&) noexcept = delete;
 
            ~Hopper() noexcept;
 
            Hopper& operator=(const Hopper&) = delete;
 
            Hopper& operator=(Hopper&&) noexcept = delete;
 
            StormByte::Size Capacity() const noexcept;
 
            void Capacity(StormByte::Size capacity) noexcept;
 
            StormByte::Size Size() const noexcept;
 
            bool Full() const noexcept;
 
            unsigned Writers() const noexcept;
 
            void Push(T item) noexcept;
 
            Hopper& operator<<(T item) noexcept;
 
            void Eof() noexcept;
 
            T Pop() noexcept;
 
            T Front() const noexcept requires std::copy_constructible<T>;
 
            Hopper& operator>>(T& item) noexcept;
 
            bool EoF() const noexcept;
 
            bool Empty() const noexcept;
 
            bool Ready() 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_io;   
    };
}
 
#include <StormByte/buffer/hopper.txx>