StormByte-Buffer 2.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
 
 ReadTelemetry (ReadTelemetry &&)=delete
 
virtual ~ReadTelemetry () noexcept override
 Virtual destructor.
 
ReadTelemetry & operator= (const ReadTelemetry &)=delete
 
ReadTelemetry & operator= (ReadTelemetry &&)=delete
 
StormByte::ByteSize Delivered () const noexcept
 Octets delivered to the caller.
 
 operator StormByte::String::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.
 
STORMBYTE_FORCE_INLINE operator std::string () const
 Flatten via StormByte::String::String in this TU.
 

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
 
 Telemetry (Telemetry &&)=delete
 
Telemetry & operator= (const Telemetry &)=delete
 
Telemetry & operator= (Telemetry &&)=delete
 
void DeltaOperation (StormByte::ByteSize bytes, std::chrono::microseconds elapsed) noexcept
 Accumulate one requested operation and refresh MeanRate.
 

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

◆ ReadTelemetry() [3/3]

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

◆ ~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::String::String()

StormByte::Buffer::ReadTelemetry::operator StormByte::String::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

◆ operator=() [2/2]

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

Friends And Related Symbol Documentation

◆ Bridge

friend class Bridge
friend

Member Data Documentation

◆ m_delivered

StormByte::ByteSize StormByte::Buffer::ReadTelemetry::m_delivered
protected

Octets delivered.


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