QuantumLibrary
Bloomberg::quantum::QueueStatistics Class Reference

Provides various counters related to queues and task execution. More...

#include <quantum_queue_statistics.h>

Inheritance diagram for Bloomberg::quantum::QueueStatistics:
Bloomberg::quantum::IQueueStatistics

Public Member Functions

 QueueStatistics ()
 
void reset () final
 Reset all the counters to 0. More...
 
size_t numElements () const final
 Gets the current size of the queue. More...
 
void incNumElements () final
 Increment this counter. More...
 
void decNumElements () final
 Decrement this counter. More...
 
size_t errorCount () const final
 Count of all coroutine and IO task execution errors on this queue. More...
 
void incErrorCount () final
 Increment this counter. More...
 
size_t sharedQueueErrorCount () const final
 Count of all IO tasks which were dequeued from the shared queue and failed. More...
 
void incSharedQueueErrorCount () final
 Increment this counter. More...
 
size_t completedCount () const final
 Count of all coroutine and IO tasks which completed successfully. More...
 
void incCompletedCount () final
 Increment this counter. More...
 
size_t sharedQueueCompletedCount () const final
 Count of all IO tasks which were dequeued from the shared queue and completed successfully. More...
 
void incSharedQueueCompletedCount () final
 Increment this counter. More...
 
size_t postedCount () const final
 Count of all coroutine and IO tasks which were posted on this queue. More...
 
void incPostedCount () final
 Increment this counter. More...
 
size_t highPriorityCount () const final
 Count of all coroutine and IO tasks which were posted on this queue at higher priority. More...
 
void incHighPriorityCount () final
 Increment this counter. More...
 
void print (std::ostream &out) const final
 Print to std::cout the value of all internal counters. More...
 
QueueStatisticsoperator+= (const IQueueStatistics &rhs)
 
- Public Member Functions inherited from Bloomberg::quantum::IQueueStatistics
virtual ~IQueueStatistics ()
 Virtual destructor. More...
 

Friends

class TaskQueue
 
class IOQueue
 
QueueStatistics operator+ (QueueStatistics lhs, const IQueueStatistics &rhs)
 

Detailed Description

Provides various counters related to queues and task execution.

Note
See IQueueStatistics for detailed description.

Constructor & Destructor Documentation

◆ QueueStatistics()

Bloomberg::quantum::QueueStatistics::QueueStatistics ( )
inline

Member Function Documentation

◆ completedCount()

size_t Bloomberg::quantum::QueueStatistics::completedCount ( ) const
inlinefinalvirtual

Count of all coroutine and IO tasks which completed successfully.

Returns
Counter value.

Implements Bloomberg::quantum::IQueueStatistics.

◆ decNumElements()

void Bloomberg::quantum::QueueStatistics::decNumElements ( )
inlinefinalvirtual

Decrement this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ errorCount()

size_t Bloomberg::quantum::QueueStatistics::errorCount ( ) const
inlinefinalvirtual

Count of all coroutine and IO task execution errors on this queue.

Returns
Counter value.

Implements Bloomberg::quantum::IQueueStatistics.

◆ highPriorityCount()

size_t Bloomberg::quantum::QueueStatistics::highPriorityCount ( ) const
inlinefinalvirtual

Count of all coroutine and IO tasks which were posted on this queue at higher priority.

Returns
Counter value.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incCompletedCount()

void Bloomberg::quantum::QueueStatistics::incCompletedCount ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incErrorCount()

void Bloomberg::quantum::QueueStatistics::incErrorCount ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incHighPriorityCount()

void Bloomberg::quantum::QueueStatistics::incHighPriorityCount ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incNumElements()

void Bloomberg::quantum::QueueStatistics::incNumElements ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incPostedCount()

void Bloomberg::quantum::QueueStatistics::incPostedCount ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incSharedQueueCompletedCount()

void Bloomberg::quantum::QueueStatistics::incSharedQueueCompletedCount ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ incSharedQueueErrorCount()

void Bloomberg::quantum::QueueStatistics::incSharedQueueErrorCount ( )
inlinefinalvirtual

Increment this counter.

Implements Bloomberg::quantum::IQueueStatistics.

◆ numElements()

size_t Bloomberg::quantum::QueueStatistics::numElements ( ) const
inlinefinalvirtual

Gets the current size of the queue.

Implements Bloomberg::quantum::IQueueStatistics.

◆ operator+=()

QueueStatistics & Bloomberg::quantum::QueueStatistics::operator+= ( const IQueueStatistics rhs)
inline

◆ postedCount()

size_t Bloomberg::quantum::QueueStatistics::postedCount ( ) const
inlinefinalvirtual

Count of all coroutine and IO tasks which were posted on this queue.

Returns
Counter value.

Implements Bloomberg::quantum::IQueueStatistics.

◆ print()

void Bloomberg::quantum::QueueStatistics::print ( std::ostream &  out) const
inlinefinalvirtual

Print to std::cout the value of all internal counters.

Parameters
[in,out]outOutput stream.

Implements Bloomberg::quantum::IQueueStatistics.

◆ reset()

void Bloomberg::quantum::QueueStatistics::reset ( )
inlinefinalvirtual

Reset all the counters to 0.

Implements Bloomberg::quantum::IQueueStatistics.

◆ sharedQueueCompletedCount()

size_t Bloomberg::quantum::QueueStatistics::sharedQueueCompletedCount ( ) const
inlinefinalvirtual

Count of all IO tasks which were dequeued from the shared queue and completed successfully.

Returns
Counter value.

Implements Bloomberg::quantum::IQueueStatistics.

◆ sharedQueueErrorCount()

size_t Bloomberg::quantum::QueueStatistics::sharedQueueErrorCount ( ) const
inlinefinalvirtual

Count of all IO tasks which were dequeued from the shared queue and failed.

Returns
Counter value.

Implements Bloomberg::quantum::IQueueStatistics.

Friends And Related Function Documentation

◆ IOQueue

friend class IOQueue
friend

◆ operator+

QueueStatistics operator+ ( QueueStatistics  lhs,
const IQueueStatistics rhs 
)
friend

◆ TaskQueue

friend class TaskQueue
friend