QuantumLibrary
Bloomberg::quantum::SequenceKeyStatistics Class Reference

Implementation of a statistics collection for a SequenceKey in Sequencer. More...

#include <quantum_sequence_key_statistics.h>

Inheritance diagram for Bloomberg::quantum::SequenceKeyStatistics:
Bloomberg::quantum::SequenceKeyStatisticsWriter

Public Member Functions

 SequenceKeyStatistics ()=default
 Constructor. More...
 
 SequenceKeyStatistics (const SequenceKeyStatistics &that)
 Constructor. More...
 
 SequenceKeyStatistics (SequenceKeyStatistics &&that)
 Constructor. More...
 
SequenceKeyStatisticsoperator= (const SequenceKeyStatistics &that)
 Assignment operator. More...
 
SequenceKeyStatisticsoperator= (SequenceKeyStatistics &&that)
 Assignment operator. More...
 
size_t getPostedTaskCount () const
 Gets the total number of tasks associated with the key that have been posted to the Sequencer since the sequencer started tracking the key. More...
 
size_t getPendingTaskCount () const
 Gets the total number of pending tasks associated with the key. More...
 

Protected Attributes

size_t _postedTaskCount {0}
 Number of posted tasks associated with the sequence key. More...
 
std::atomic< size_t > _pendingTaskCount {0}
 Number of pending tasks associated with the sequence key. More...
 

Detailed Description

Implementation of a statistics collection for a SequenceKey in Sequencer.

Implementation of a writer for the SequenceKeyStatistics.

Constructor & Destructor Documentation

◆ SequenceKeyStatistics() [1/3]

Bloomberg::quantum::SequenceKeyStatistics::SequenceKeyStatistics ( )
default

Constructor.

◆ SequenceKeyStatistics() [2/3]

Bloomberg::quantum::SequenceKeyStatistics::SequenceKeyStatistics ( const SequenceKeyStatistics that)
inline

Constructor.

◆ SequenceKeyStatistics() [3/3]

Bloomberg::quantum::SequenceKeyStatistics::SequenceKeyStatistics ( SequenceKeyStatistics &&  that)
inline

Constructor.

Member Function Documentation

◆ getPendingTaskCount()

size_t Bloomberg::quantum::SequenceKeyStatistics::getPendingTaskCount ( ) const
inline

Gets the total number of pending tasks associated with the key.

Remarks
A task is pending if the dispatcher has not started it yet
Returns
the number of tasks

◆ getPostedTaskCount()

size_t Bloomberg::quantum::SequenceKeyStatistics::getPostedTaskCount ( ) const
inline

Gets the total number of tasks associated with the key that have been posted to the Sequencer since the sequencer started tracking the key.

Returns
the number of tasks

◆ operator=() [1/2]

SequenceKeyStatistics & Bloomberg::quantum::SequenceKeyStatistics::operator= ( const SequenceKeyStatistics that)
inline

Assignment operator.

◆ operator=() [2/2]

SequenceKeyStatistics & Bloomberg::quantum::SequenceKeyStatistics::operator= ( SequenceKeyStatistics &&  that)
inline

Assignment operator.

Member Data Documentation

◆ _pendingTaskCount

std::atomic<size_t> Bloomberg::quantum::SequenceKeyStatistics::_pendingTaskCount {0}
protected

Number of pending tasks associated with the sequence key.

◆ _postedTaskCount

size_t Bloomberg::quantum::SequenceKeyStatistics::_postedTaskCount {0}
protected

Number of posted tasks associated with the sequence key.