Ice 3.7 C++98 API Reference
Loading...
Searching...
No Matches
IceMX::TopicMetrics Class Reference

Provides information on IceStorm topics. More...

#include <IceStorm/IceStorm.h>

Inheritance diagram for IceMX::TopicMetrics:
Collaboration diagram for IceMX::TopicMetrics:

Public Types

typedef TopicMetricsPtr PointerType
typedef TopicMetricsPrx ProxyType
Public Types inherited from IceMX::Metrics
typedef MetricsPtr PointerType
typedef MetricsPrx ProxyType

Public Member Functions

virtual::Ice::ObjectPtr ice_clone () const
 Polymorphically clones this object.
virtual const ::std::string & ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string > ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
 Determines whether this object supports an interface with the given Slice type ID.
 TopicMetrics ()
 Default constructor that assigns default values to members as specified in the Slice definition.
 TopicMetrics (const ::std::string &id, ::Ice::Long total, ::Ice::Int current, ::Ice::Long totalLifetime, ::Ice::Int failures, ::Ice::Long published, ::Ice::Long forwarded)
 One-shot constructor to initialize all data members.
virtual ~TopicMetrics ()
Public Member Functions inherited from IceMX::Metrics
virtual ::std::vector< ::std::string > ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a list of the Slice type IDs representing the interfaces supported by this object.
 Metrics ()
 Default constructor that assigns default values to members as specified in the Slice definition.
 Metrics (const ::std::string &id, ::Ice::Long total, ::Ice::Int current, ::Ice::Long totalLifetime, ::Ice::Int failures)
 One-shot constructor to initialize all data members.
virtual ~Metrics ()
Public Member Functions inherited from Ice::Object
virtual void ice_collectable (bool b)
 Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released.
virtual bool ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
 Dispatches an invocation to a servant.
virtual SlicedDataPtr ice_getSlicedData () const
 Obtains the sliced data associated with this instance.
virtual const std::string & ice_id (const Current &current=Ice::emptyCurrent) const
 Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string > ice_ids (const Current &current=Ice::emptyCurrent) const
 Returns the Slice type IDs of the interfaces supported by this object.
virtual bool ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
 Tests whether this object supports a specific Slice interface.
virtual Int ice_operationAttributes (const std::string &operation) const
 Returns the Freeze metadata attributes for an operation.
virtual void ice_ping (const Current &current=Ice::emptyCurrent) const
 Tests whether this object can be reached.
virtual void ice_postUnmarshal ()
 The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void ice_preMarshal ()
 The Ice run time invokes this method prior to marshaling an object's data members.
virtual bool operator< (const Object &) const
virtual bool operator== (const Object &) const
Public Member Functions inherited from IceUtil::Shared
void __clearFlag (unsigned char flag)
virtual void __decRef ()
virtual int __getRef () const
bool __hasFlag (unsigned char flag)
virtual void __incRef ()
void __setFlag (unsigned char flag)
virtual void __setNoDelete (bool)
Sharedoperator= (const Shared &)
 Shared ()
 Shared (const Shared &)
virtual ~Shared ()

Static Public Member Functions

::Ice::ValueFactoryPtr ice_factory ()
 Obtains a value factory that instantiates this class.
static const ::std::string & ice_staticId ()
 Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from IceMX::Metrics
::Ice::ValueFactoryPtr ice_factory ()
 Obtains a value factory that instantiates this class.
static const ::std::string & ice_staticId ()
 Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type.

Public Attributes

::Ice::Long forwarded
 Number of events forwarded on the topic by IceStorm topic links.
::Ice::Long published
 Number of events published on the topic by publishers.
Public Attributes inherited from IceMX::Metrics
::Ice::Int current
 The number of objects currently observed by this metrics.
::Ice::Int failures
 The number of failures observed.
::std::string id
 The metrics identifier.
::Ice::Long total
 The total number of objects observed by this metrics.
::Ice::Long totalLifetime
 The sum of the lifetime of each observed objects.

Additional Inherited Members

Static Public Attributes inherited from IceUtil::Shared
static const unsigned char NoDelete
Protected Member Functions inherited from Ice::Object
 Object ()
virtual ~Object ()
Protected Attributes inherited from IceUtil::Shared
unsigned char _flags
IceUtilInternal::Atomic _ref

Detailed Description

Provides information on IceStorm topics.

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~TopicMetrics()

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

◆ TopicMetrics() [1/2]

IceMX::TopicMetrics::TopicMetrics ( )
inline

Default constructor that assigns default values to members as specified in the Slice definition.

◆ TopicMetrics() [2/2]

IceMX::TopicMetrics::TopicMetrics ( const ::std::string & id,
::Ice::Long total,
::Ice::Int current,
::Ice::Long totalLifetime,
::Ice::Int failures,
::Ice::Long published,
::Ice::Long 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_clone()

virtual::Ice::ObjectPtr IceMX::TopicMetrics::ice_clone ( ) const
virtual

Polymorphically clones this object.

Returns
A shallow copy of this object.

Reimplemented from IceMX::Metrics.

◆ ice_factory()

::Ice::ValueFactoryPtr IceMX::TopicMetrics::ice_factory ( )
static

Obtains a value factory that instantiates this class.

Returns
The value factory.

◆ ice_id()

virtual const ::std::string & IceMX::TopicMetrics::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent) const
virtual

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A fully-scoped type ID.

Reimplemented from IceMX::Metrics.

◆ ice_ids()

virtual ::std::vector< ::std::string > IceMX::TopicMetrics::ice_ids ( const ::Ice::Current & current = ::Ice::emptyCurrent) const

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceMX::TopicMetrics::ice_isA ( const ::std::string & id,
const ::Ice::Current & current = ::Ice::emptyCurrent ) const
virtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters
idThe fully-scoped Slice type ID.
currentThe Current object for the invocation.
Returns
True if this object supports the interface, false, otherwise.

Reimplemented from IceMX::Metrics.

◆ ice_staticId()

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

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

Member Data Documentation

◆ forwarded

::Ice::Long IceMX::TopicMetrics::forwarded

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

◆ published

::Ice::Long IceMX::TopicMetrics::published

Number of events published on the topic by publishers.


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