develop/ADynamicPipe_8h_source.html

/*

 * AUI Framework - Declarative UI toolkit for modern C++20

 * Copyright (C) 2020-2024 Alex2772 and Contributors

 *

 * SPDX-License-Identifier: MPL-2.0

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 */


#pragma once


#include "IInputStream.h"

#include "IOutputStream.h"

#include "AUI/Common/AQueue.h"

#include <array>


class API_AUI_CORE ADynamicPipe: public IInputStream, public IOutputStream {

public:

    ~ADynamicPipe() override = default;


    void write(const char* src, size_t size) override;

    size_t read(char* dst, size_t size) override;


    [[nodiscard]]

    bool empty() const noexcept {

        return mQueue.empty();

    }


private:

    static constexpr std::size_t FRAGMENT_CAPACITY = 0x10000;


    struct Fragment {

        std::array<std::uint8_t, FRAGMENT_CAPACITY> data;

        std::size_t writerPos = 0;

        std::size_t readerPos = 0;


        [[nodiscard]]

        std::size_t writerRemaining() const noexcept { return FRAGMENT_CAPACITY - writerPos; }


        [[nodiscard]]

        std::size_t readerRemaining() const noexcept { return writerPos - readerPos; }


        void push(const char*& src, size_t& size) {

            std::size_t sizeForCurrentFragment = glm::min(size, writerRemaining());

            std::memcpy(data.data() + writerPos, src, sizeForCurrentFragment);

            writerPos += sizeForCurrentFragment;

            src += sizeForCurrentFragment;

            size -= sizeForCurrentFragment;

        }

    };


    AQueue<Fragment> mQueue;

};


ADynamicPipe
An asynchronous buffer that converts an IInputStream to IOutputStream (and otherwise).
Definition ADynamicPipe.h:29

ADynamicPipe::read
size_t read(char *dst, size_t size) override
Reads up to size bytes from stream. Blocking (waiting for new data) is allowed.

ADynamicPipe::write
void write(const char *src, size_t size) override
Writes exact size bytes to stream. Blocking (waiting for write all data) is allowed.

IInputStream
Represents an input stream.
Definition IInputStream.h:26

IOutputStream
Definition IOutputStream.h:18