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

Provides information on IceStorm topics. More...

#include <IceStorm/IceStorm.h>

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

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

long long int forwarded = 0LL
 Number of events forwarded on the topic by IceStorm topic links. More...
 
long long int published = 0LL
 Number of events published on the topic by publishers. More...
 

Detailed Description

Provides information on IceStorm topics.

Constructor & Destructor Documentation

◆ ~TopicMetrics()

virtual IceMX::TopicMetrics::~TopicMetrics ( )
virtual

◆ TopicMetrics() [1/4]

IceMX::TopicMetrics::TopicMetrics ( )
default

◆ TopicMetrics() [2/4]

IceMX::TopicMetrics::TopicMetrics ( const TopicMetrics )
default

◆ TopicMetrics() [3/4]

IceMX::TopicMetrics::TopicMetrics ( TopicMetrics &&  )
default

◆ TopicMetrics() [4/4]

IceMX::TopicMetrics::TopicMetrics ( const ::std::string &  id,
long long int  total,
int  current,
long long int  totalLifetime,
int  failures,
long long int  published,
long long int  forwarded 
)
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.
publishedNumber of events published on the topic by publishers.
forwardedNumber of events forwarded on the topic by IceStorm topic links.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceMX::TopicMetrics::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 long long int&, const long long int&> IceMX::TopicMetrics::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]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ forwarded

long long int IceMX::TopicMetrics::forwarded = 0LL

Number of events forwarded on the topic by IceStorm topic links.

◆ published

long long int IceMX::TopicMetrics::published = 0LL

Number of events published on the topic by publishers.


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