StormByte::Buffer::Telemetry Class Reference

Base session counters. More...

#include <StormByte/buffer/telemetry.hxx>

Inheritance diagram for StormByte::Buffer::Telemetry:

Public Member Functions
virtual	~Telemetry () noexcept
	Virtual destructor.
StormByte::ByteSize	MeanRate () const noexcept
	Effective mean rate of requested user operations.
virtual	operator StormByte::String::String () const =0
	Flatten counters.
STORMBYTE_FORCE_INLINE	operator std::string () const
	Flatten via StormByte::String::String in this TU.

Protected Member Functions
	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.

Friends
class	Bridge

Detailed Description

Base session counters.

Offices call DeltaOperation.

MeanRate

Octets per second of requested user operations, not of the device. A cache Write can look like GiB/s; that is the caller rate, not a disk benchmark. Worker, GC and backpressure enter only when they delay that call. Explicit Flush / Close Flush pull the rate back when the origin works.

Not wall time from Open. 0 until an operation has a non-zero duration. Flatten prints StormByte::ByteSize IEC text plus "/s".

Rate fields are atomics. DeltaOperation takes no mutex.

Constructor & Destructor Documentation

~Telemetry()

virtual StormByte::Buffer::Telemetry::~Telemetry ( )

virtualnoexcept

Virtual destructor.

Out-of-line for the DLL boundary.

Telemetry() [1/3]

StormByte::Buffer::Telemetry::Telemetry ( )

protectednoexcept

Construct all counters at 0.

Telemetry() [2/3]

StormByte::Buffer::Telemetry::Telemetry ( const Telemetry &  )

protecteddelete

Telemetry() [3/3]

StormByte::Buffer::Telemetry::Telemetry ( Telemetry &&  )

protecteddelete

Member Function Documentation

DeltaOperation()

void StormByte::Buffer::Telemetry::DeltaOperation ( StormByte::ByteSize  bytes, std::chrono::microseconds  elapsed  )

protectednoexcept

Accumulate one requested operation and refresh MeanRate.

Parameters

bytes	Octets this operation delivered or accepted.
elapsed	Duration of that operation. 0 does not divide.

MeanRate()

StormByte::ByteSize StormByte::Buffer::Telemetry::MeanRate ( ) const

noexcept

Effective mean rate of requested user operations.

Returns

Octets per second. 0 if no timed operation yet.

Not origin throughput.

operator std::string()

STORMBYTE_FORCE_INLINE StormByte::Buffer::Telemetry::operator std::string ( ) const

inline

Flatten via StormByte::String::String in this TU.

Returns

std::string on the caller heap.

operator StormByte::String::String()

virtual StormByte::Buffer::Telemetry::operator StormByte::String::String ( ) const

pure virtual

Flatten counters.

Safe across the DLL boundary.

Returns

Owned StormByte::String::String.

Implemented in StormByte::Buffer::IO::ReadTelemetry, StormByte::Buffer::IO::WriteTelemetry, StormByte::Buffer::ReadTelemetry, and StormByte::Buffer::WriteTelemetry.

operator=() [1/2]

Telemetry & StormByte::Buffer::Telemetry::operator= ( const Telemetry &  )

protecteddelete

operator=() [2/2]

Telemetry & StormByte::Buffer::Telemetry::operator= ( Telemetry &&  )

protecteddelete

Friends And Related Symbol Documentation

Bridge

friend class Bridge

friend

---

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

• lib/public/StormByte/buffer/telemetry.hxx