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

Provide measurements for proxy invocations. More...

#include <Ice/Ice.h>

Inheritance diagram for IceMX::InvocationMetrics:
Inheritance graph
[legend]
Collaboration diagram for IceMX::InvocationMetrics:
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 ::IceMX::MetricsMap &, const ::IceMX::MetricsMap & > ice_tuple () const
 Obtains a tuple containing all of the value's data members. More...
 
 InvocationMetrics ()=default
 
 InvocationMetrics (const ::std::string &id, long long int total, int current, long long int totalLifetime, int failures, int retry, int userException, const ::IceMX::MetricsMap &remotes, const ::IceMX::MetricsMap &collocated)
 One-shot constructor to initialize all data members. More...
 
 InvocationMetrics (const InvocationMetrics &)=default
 
 InvocationMetrics (InvocationMetrics &&)=default
 
InvocationMetricsoperator= (const InvocationMetrics &)=default
 
InvocationMetricsoperator= (InvocationMetrics &&)=default
 
virtual ~InvocationMetrics ()
 

Static Public Member Functions

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

Public Attributes

::IceMX::MetricsMap collocated
 The collocated invocation metrics map. More...
 
::IceMX::MetricsMap remotes
 The remote invocation metrics map. More...
 
int retry = 0
 The number of retries for the invocation(s). More...
 
int userException = 0
 The number of invocations that failed with a user exception. More...
 

Detailed Description

Provide measurements for proxy invocations.

Proxy invocations can either be sent over the wire or be collocated.

Constructor & Destructor Documentation

◆ ~InvocationMetrics()

virtual IceMX::InvocationMetrics::~InvocationMetrics ( )
virtual

◆ InvocationMetrics() [1/4]

IceMX::InvocationMetrics::InvocationMetrics ( )
default

◆ InvocationMetrics() [2/4]

IceMX::InvocationMetrics::InvocationMetrics ( const InvocationMetrics )
default

◆ InvocationMetrics() [3/4]

IceMX::InvocationMetrics::InvocationMetrics ( InvocationMetrics &&  )
default

◆ InvocationMetrics() [4/4]

IceMX::InvocationMetrics::InvocationMetrics ( const ::std::string &  id,
long long int  total,
int  current,
long long int  totalLifetime,
int  failures,
int  retry,
int  userException,
const ::IceMX::MetricsMap remotes,
const ::IceMX::MetricsMap collocated 
)
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.
retryThe number of retries for the invocation(s).
userExceptionThe number of invocations that failed with a user exception.
remotesThe remote invocation metrics map.
collocatedThe collocated invocation metrics map.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceMX::InvocationMetrics::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 ::IceMX::MetricsMap&, const ::IceMX::MetricsMap&> IceMX::InvocationMetrics::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]

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

◆ operator=() [2/2]

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

Member Data Documentation

◆ collocated

::IceMX::MetricsMap IceMX::InvocationMetrics::collocated

The collocated invocation metrics map.

See also
CollocatedMetrics

◆ remotes

::IceMX::MetricsMap IceMX::InvocationMetrics::remotes

The remote invocation metrics map.

See also
RemoteMetrics

◆ retry

int IceMX::InvocationMetrics::retry = 0

The number of retries for the invocation(s).

◆ userException

int IceMX::InvocationMetrics::userException = 0

The number of invocations that failed with a user exception.


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