io_counter.h

Go to the documentation of this file.

// Copyright 2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/io_writeable.h>
 
namespace satcat5 {
    namespace io {
        class Counter {
        public:
            virtual unsigned byte_count(bool reset = true) = 0;
 
            virtual unsigned frame_count(bool reset = true) = 0;
 
            virtual unsigned error_count(bool reset = true) // GCOVR_EXCL_LINE
                { return 0; }                               // GCOVR_EXCL_LINE
        };
 
        class CounterSimple : public satcat5::io::Counter {
        public:
            // Implement the Counter API.
            unsigned byte_count(bool reset = true) override;
            unsigned frame_count(bool reset = true) override;
            unsigned error_count(bool reset = true) override;
 
            inline void byte_incr(unsigned incr)
                { m_byte_ct += incr; }
            inline void frame_incr(unsigned incr)
                { m_frm_ct += incr; }
            inline void error_incr(unsigned incr)
                { m_err_ct += incr; }
 
        protected:
            constexpr CounterSimple()
                : m_byte_ct(0), m_err_ct(0), m_frm_ct(0), m_frm_len(0) {}
            ~CounterSimple() {}
 
            // Counter variables are incremented by the child class.
            unsigned m_byte_ct;     
            unsigned m_err_ct;      
            unsigned m_frm_ct;      
            unsigned m_frm_len;     
        };
 
        class CounterInline
            : public satcat5::io::CounterSimple
            , public satcat5::io::WriteableRedirect
        {
        public:
            explicit constexpr CounterInline(satcat5::io::Writeable* dst)
                : WriteableRedirect(dst) {}
 
            // Implement the Writeable API.
            void write_abort() override;
            void write_bytes(unsigned nbytes, const void* src) override;
            bool write_finalize() override;
        protected:
            void write_next(u8 data) override;
        };
 
        struct TrafficStats {
            unsigned sent_bytes;    
            unsigned sent_frames;   
            unsigned rcvd_bytes;    
            unsigned rcvd_frames;   
            unsigned rcvd_errors;   
 
            TrafficStats() = default;
            TrafficStats(const TrafficStats& t) = default;
            TrafficStats& operator=(const TrafficStats& t) = default;
 
            bool any() const;
 
            static TrafficStats query(
                satcat5::io::Counter& rx,
                satcat5::io::Counter& tx);
        };
    }
}