Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
IceMX::SubscriberMetrics Class Reference

Provides information on IceStorm subscribers. More...

#include <IceStorm/IceStorm.h>

Inheritance diagram for IceMX::SubscriberMetrics:
Inheritance graph
[legend]
Collaboration diagram for IceMX::SubscriberMetrics:
Collaboration graph
[legend]

Public Member Functions

std::tuple< const ::std::string &, const long long int &, const int &, const long long int &, const int &, const int &, const int &, const long long int & > ice_tuple () const
 Obtains a tuple containing all of the value's data members. More...
 
SubscriberMetricsoperator= (const SubscriberMetrics &)=default
 
SubscriberMetricsoperator= (SubscriberMetrics &&)=default
 
 SubscriberMetrics ()=default
 
 SubscriberMetrics (const ::std::string &id, long long int total, int current, long long int totalLifetime, int failures, int queued, int outstanding, long long int delivered)
 One-shot constructor to initialize all data members. More...
 
 SubscriberMetrics (const SubscriberMetrics &)=default
 
 SubscriberMetrics (SubscriberMetrics &&)=default
 
virtual ~SubscriberMetrics ()
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this value. More...
 

Public Attributes

long long int delivered = 0LL
 Number of forwarded events. More...
 
int outstanding = 0
 Number of outstanding events. More...
 
int queued = 0
 Number of queued events. More...
 

Detailed Description

Provides information on IceStorm subscribers.

Constructor & Destructor Documentation

◆ ~SubscriberMetrics()

virtual IceMX::SubscriberMetrics::~SubscriberMetrics ( )
virtual

◆ SubscriberMetrics() [1/4]

IceMX::SubscriberMetrics::SubscriberMetrics ( )
default

◆ SubscriberMetrics() [2/4]

IceMX::SubscriberMetrics::SubscriberMetrics ( const SubscriberMetrics )
default

◆ SubscriberMetrics() [3/4]

IceMX::SubscriberMetrics::SubscriberMetrics ( SubscriberMetrics &&  )
default

◆ SubscriberMetrics() [4/4]

IceMX::SubscriberMetrics::SubscriberMetrics ( const ::std::string &  id,
long long int  total,
int  current,
long long int  totalLifetime,
int  failures,
int  queued,
int  outstanding,
long long int  delivered 
)
inline

One-shot constructor to initialize all data members.

Parameters
idThe metrics identifier.
totalThe total number of objects observed by this metrics.
currentThe number of objects currently observed by this metrics.
totalLifetimeThe sum of the lifetime of each observed objects.
failuresThe number of failures observed.
queuedNumber of queued events.
outstandingNumber of outstanding events.
deliveredNumber of forwarded events.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceMX::SubscriberMetrics::ice_staticId ( )
static

Obtains the Slice type ID of this value.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const ::std::string&, const long long int&, const int&, const long long int&, const int&, const int&, const int&, const long long int&> IceMX::SubscriberMetrics::ice_tuple ( ) const
inline

Obtains a tuple containing all of the value's data members.

Returns
The data members in a tuple.

◆ operator=() [1/2]

SubscriberMetrics& IceMX::SubscriberMetrics::operator= ( const SubscriberMetrics )
default

◆ operator=() [2/2]

SubscriberMetrics& IceMX::SubscriberMetrics::operator= ( SubscriberMetrics &&  )
default

Member Data Documentation

◆ delivered

long long int IceMX::SubscriberMetrics::delivered = 0LL

Number of forwarded events.

◆ outstanding

int IceMX::SubscriberMetrics::outstanding = 0

Number of outstanding events.

◆ queued

int IceMX::SubscriberMetrics::queued = 0

Number of queued events.


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