StormByte::Buffer::Telemetry::OperationSample Class Reference

Measures one operation with a Base named clock. More...

#include <StormByte/buffer/telemetry.hxx>

Public Member Functions
	OperationSample (const OperationSample &)=delete
	Copy construction is disabled.
	OperationSample (OperationSample &&other) noexcept
OperationSample &	operator= (const OperationSample &)=delete
	Copy assignment is disabled.
OperationSample &	operator= (OperationSample &&)=delete
	Move assignment is disabled.
	~OperationSample () noexcept
	Stops the clock and records a committed operation.
void	Commit (StormByte::ByteSize bytes) noexcept
	Includes this sample in the rate calculation.

Friends
class	Telemetry

Detailed Description

Measures one operation with a Base named clock.

Constructor & Destructor Documentation

OperationSample() [1/2]

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

delete

Copy construction is disabled.

OperationSample() [2/2]

StormByte::Buffer::Telemetry::OperationSample::OperationSample ( OperationSample &&  other )

noexcept

@brief Transfers the active sample on its creating thread.

Parameters

other

Sample to take.

~OperationSample()

StormByte::Buffer::Telemetry::OperationSample::~OperationSample ( )

noexcept

Stops the clock and records a committed operation.

Note

Destroy on the thread that created this sample.

Member Function Documentation

Commit()

void StormByte::Buffer::Telemetry::OperationSample::Commit ( StormByte::ByteSize  bytes )

noexcept

Includes this sample in the rate calculation.

Parameters

bytes

Bytes delivered or accepted by the operation.

operator=() [1/2]

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

delete

Copy assignment is disabled.

operator=() [2/2]

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

delete

Move assignment is disabled.

Friends And Related Symbol Documentation

Telemetry

friend class Telemetry

friend

---

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

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