QuantumLibrary
Bloomberg::quantum::IQueueStatistics Interface Referenceabstract

Interface to access and manipulate a QueueStatistics object. More...

#include <quantum_iqueue_statistics.h>

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

Public Member Functions

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

Detailed Description

Interface to access and manipulate a QueueStatistics object.

Constructor & Destructor Documentation

◆ ~IQueueStatistics()

virtual Bloomberg::quantum::IQueueStatistics::~IQueueStatistics ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ completedCount()

virtual size_t Bloomberg::quantum::IQueueStatistics::completedCount ( ) const
pure virtual

Count of all coroutine and IO tasks which completed successfully.

Returns
Counter value.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ decNumElements()

virtual void Bloomberg::quantum::IQueueStatistics::decNumElements ( )
pure virtual

Decrement this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ errorCount()

virtual size_t Bloomberg::quantum::IQueueStatistics::errorCount ( ) const
pure virtual

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

Returns
Counter value.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ highPriorityCount()

virtual size_t Bloomberg::quantum::IQueueStatistics::highPriorityCount ( ) const
pure virtual

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

Returns
Counter value.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incCompletedCount()

virtual void Bloomberg::quantum::IQueueStatistics::incCompletedCount ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incErrorCount()

virtual void Bloomberg::quantum::IQueueStatistics::incErrorCount ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incHighPriorityCount()

virtual void Bloomberg::quantum::IQueueStatistics::incHighPriorityCount ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incNumElements()

virtual void Bloomberg::quantum::IQueueStatistics::incNumElements ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incPostedCount()

virtual void Bloomberg::quantum::IQueueStatistics::incPostedCount ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incSharedQueueCompletedCount()

virtual void Bloomberg::quantum::IQueueStatistics::incSharedQueueCompletedCount ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ incSharedQueueErrorCount()

virtual void Bloomberg::quantum::IQueueStatistics::incSharedQueueErrorCount ( )
pure virtual

Increment this counter.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ numElements()

virtual size_t Bloomberg::quantum::IQueueStatistics::numElements ( ) const
pure virtual

Gets the current size of the queue.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ postedCount()

virtual size_t Bloomberg::quantum::IQueueStatistics::postedCount ( ) const
pure virtual

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

Returns
Counter value.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ print()

virtual void Bloomberg::quantum::IQueueStatistics::print ( std::ostream &  out) const
pure virtual

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

Parameters
[in,out]outOutput stream.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ reset()

virtual void Bloomberg::quantum::IQueueStatistics::reset ( )
pure virtual

Reset all the counters to 0.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ sharedQueueCompletedCount()

virtual size_t Bloomberg::quantum::IQueueStatistics::sharedQueueCompletedCount ( ) const
pure virtual

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

Returns
Counter value.

Implemented in Bloomberg::quantum::QueueStatistics.

◆ sharedQueueErrorCount()

virtual size_t Bloomberg::quantum::IQueueStatistics::sharedQueueErrorCount ( ) const
pure virtual

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

Returns
Counter value.

Implemented in Bloomberg::quantum::QueueStatistics.