io_buffer.h

Go to the documentation of this file.

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/io_core.h>
#include <satcat5/pkt_buffer.h>
#include <satcat5/timeref.h>
 
namespace satcat5 {
    namespace io {
        //
        class BufferedIO
            : public    satcat5::io::ReadableRedirect
            , public    satcat5::io::WriteableRedirect
            , protected satcat5::io::EventListener
        {
        protected:
            BufferedIO(
                u8* txbuff, unsigned txbytes, unsigned txpkt,
                u8* rxbuff, unsigned rxbytes, unsigned rxpkt);
            ~BufferedIO() {}
 
            // Child MUST implement the following inherited methods:
            //  void data_rcvd(satcat5::io::Readable* src) override;
 
            satcat5::io::PacketBuffer m_tx;
 
            satcat5::io::PacketBuffer m_rx;
        };
 
        class BufferedCopy final
            : public satcat5::io::EventListener
        {
        public:
            BufferedCopy(
                satcat5::io::Readable* src,
                satcat5::io::Writeable* dst,
                satcat5::io::CopyMode mode = CopyMode::PACKET);
            ~BufferedCopy() SATCAT5_OPTIONAL_DTOR;
 
            inline satcat5::io::Writeable* dst()
                { return m_dst; }
            inline satcat5::io::Readable* src()
                { return m_src; }
 
        protected:
            void data_rcvd(satcat5::io::Readable* src) override;
            void data_unlink(satcat5::io::Readable* src) override;
 
            satcat5::io::Readable* m_src;
            satcat5::io::Writeable* const m_dst;
            satcat5::io::CopyMode m_mode;
        };
 
        class BufferedStream final
            : public satcat5::io::EventListener
        {
        public:
            BufferedStream(
                satcat5::io::Readable* src,
                satcat5::net::Address* dst,
                unsigned max_chunk = 512,
                unsigned min_txnow = UINT_MAX);
            ~BufferedStream() SATCAT5_OPTIONAL_DTOR;
 
            inline void set_timeout(unsigned msec)
                { m_timeout_msec = msec; }
 
        protected:
            // Required event handlers.
            void data_rcvd(satcat5::io::Readable* src) override;
            void data_unlink(satcat5::io::Readable* src) override;
 
            // Member variables.
            satcat5::io::Readable* m_src;
            satcat5::net::Address* const m_dst;
            const unsigned m_max_chunk;
            const unsigned m_min_txnow;
            unsigned m_timeout_msec;
            satcat5::util::TimeVal m_tref;
        };
 
        class BufferedPackets final
            : public satcat5::io::EventListener
        {
        public:
            BufferedPackets(
                satcat5::io::Readable* src,
                satcat5::net::Address* dst);
            ~BufferedPackets() SATCAT5_OPTIONAL_DTOR;
 
        protected:
            // Required event handlers.
            void data_rcvd(satcat5::io::Readable* src) override;
            void data_unlink(satcat5::io::Readable* src) override;
 
            // Member variables.
            satcat5::io::Readable* m_src;
            satcat5::net::Address* const m_dst;
        };
 
        class BufferedWriter
            : public satcat5::io::WriteableRedirect
        {
        public:
            BufferedWriter(
                satcat5::io::Writeable* dst,
                u8* txbuff, unsigned txbytes, unsigned txpkt);
 
        protected:
            satcat5::io::PacketBuffer m_buff;
            satcat5::io::BufferedCopy m_copy;
        };
    }
}