StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Buffer::ReadTelemetry Class Reference

Basic read counters. More...

#include <StormByte/buffer/telemetry.hxx>

Inheritance diagram for StormByte::Buffer::ReadTelemetry:
Collaboration diagram for StormByte::Buffer::ReadTelemetry:

Public Member Functions

 ReadTelemetry () noexcept
 Construct all counters at 0.
 ReadTelemetry (const ReadTelemetry &)=delete
 Copy construction is disabled to preserve clock ownership.
 ReadTelemetry (ReadTelemetry &&)=delete
 Move construction is disabled while samples may borrow this object.
virtual ~ReadTelemetry () noexcept override
 Virtual destructor.
ReadTelemetry & operator= (const ReadTelemetry &)=delete
 Copy assignment is disabled to preserve clock ownership.
ReadTelemetry & operator= (ReadTelemetry &&)=delete
 Move assignment is disabled while samples may borrow this object.
StormByte::ByteSize Delivered () const noexcept
 Octets delivered to the caller.
 operator StormByte::Safe::String () const override
 Flatten base read counters.
Public Member Functions inherited from StormByte::Buffer::Telemetry
virtual ~Telemetry () noexcept
 Virtual destructor.
StormByte::ByteSize MeanRate () const noexcept
 Effective mean rate of requested user operations.
OperationSample MeasureOperation () noexcept
 Starts an independent measurement on the aggregate operation clock.
STORMBYTE_FORCE_INLINE operator std::string () const
 Flatten via StormByte::Safe::String in this TU.
Public Member Functions inherited from StormByte::Telemetry
virtual operator Safe::String () const=0
STORMBYTE_FORCE_INLINE operator std::string () const

Protected Attributes

StormByte::ByteSize m_delivered
 Octets delivered.

Friends

class Bridge

Additional Inherited Members

Protected Member Functions inherited from StormByte::Buffer::Telemetry
 Telemetry () noexcept
 Construct all counters at 0.
 Telemetry (const Telemetry &)=delete
 Copy construction is disabled to preserve clock ownership.
 Telemetry (Telemetry &&)=delete
 Move construction is disabled while samples may borrow this object.
Telemetry & operator= (const Telemetry &)=delete
 Copy assignment is disabled to preserve clock ownership.
Telemetry & operator= (Telemetry &&)=delete
 Move assignment is disabled while samples may borrow this object.
void RecordOperation (StormByte::ByteSize bytes, std::chrono::microseconds elapsed) noexcept
 Accumulate committed bytes and duration from a Base sample.
Protected Member Functions inherited from StormByte::Telemetry
 Telemetry () noexcept
 Telemetry (const Telemetry &)=delete
 Telemetry (Telemetry &&other) noexcept
Telemetry & operator= (const Telemetry &)=delete
Telemetry & operator= (Telemetry &&other) noexcept
class Clock & Clock (std::string_view name)
class Clock::Sample MeasureClock (std::string_view name) noexcept
const class Clock & Clock (std::string_view name) const

Detailed Description

Basic read counters.

Non-IO Bridge uses this type as-is.

Constructor & Destructor Documentation

◆ ReadTelemetry() [1/3]

StormByte::Buffer::ReadTelemetry::ReadTelemetry ( )
noexcept

Construct all counters at 0.

◆ ReadTelemetry() [2/3]

StormByte::Buffer::ReadTelemetry::ReadTelemetry ( const ReadTelemetry & )
delete

Copy construction is disabled to preserve clock ownership.

◆ ReadTelemetry() [3/3]

StormByte::Buffer::ReadTelemetry::ReadTelemetry ( ReadTelemetry && )
delete

Move construction is disabled while samples may borrow this object.

◆ ~ReadTelemetry()

virtual StormByte::Buffer::ReadTelemetry::~ReadTelemetry ( )
overridevirtualnoexcept

Virtual destructor.

Out-of-line for the DLL boundary.

Reimplemented in StormByte::Buffer::IO::ReadTelemetry.

Member Function Documentation

◆ Delivered()

StormByte::ByteSize StormByte::Buffer::ReadTelemetry::Delivered ( ) const
noexcept

Octets delivered to the caller.

Returns
Accumulator. Includes cache hits when an IO leaf derives.

◆ operator StormByte::Safe::String()

StormByte::Buffer::ReadTelemetry::operator StormByte::Safe::String ( ) const
overridevirtual

Flatten base read counters.

Returns
IEC ByteSize text. MeanRate ends with /s.

Implements StormByte::Buffer::Telemetry.

◆ operator=() [1/2]

ReadTelemetry & StormByte::Buffer::ReadTelemetry::operator= ( const ReadTelemetry & )
delete

Copy assignment is disabled to preserve clock ownership.

◆ operator=() [2/2]

ReadTelemetry & StormByte::Buffer::ReadTelemetry::operator= ( ReadTelemetry && )
delete

Move assignment is disabled while samples may borrow this object.

◆ Bridge

friend class Bridge
friend

Member Data Documentation

◆ m_delivered

StormByte::ByteSize StormByte::Buffer::ReadTelemetry::m_delivered
mutableprotected

Octets delivered.


The documentation for this class was generated from the following file: