Ice 3.7 C++11 API Reference
Public Types | Public Member Functions | Static Public Member Functions | List of all members
IceGrid::ObjectObserver Class Referenceabstract

This interface allows applications to monitor IceGrid well-known objects. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::ObjectObserver:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::ObjectObserver:
Collaboration graph
[legend]

Public Types

using ProxyType = ObjectObserverPrx
 

Public Member Functions

virtual ::std::string ice_id (const ::Ice::Current &current) const override
 Obtains a Slice type ID representing the most-derived interface supported by this object. More...
 
virtual ::std::vector<::std::string > ice_ids (const ::Ice::Current &current) const override
 Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...
 
virtual bool ice_isA (::std::string id, const ::Ice::Current &current) const override
 Determines whether this object supports an interface with the given Slice type ID. More...
 
virtual void objectAdded (ObjectInfo info, const ::Ice::Current &current)=0
 The objectAdded operation is called to notify an observer when an object was added to the Admin interface. More...
 
virtual void objectInit (ObjectInfoSeq objects, const ::Ice::Current &current)=0
 objectInit is called after the registration of an observer to indicate the state of the registry. More...
 
virtual void objectRemoved (::Ice::Identity id, const ::Ice::Current &current)=0
 objectRemoved is called to notify an observer when an object registered with the Admin interface was removed. More...
 
virtual void objectUpdated (ObjectInfo info, const ::Ice::Current &current)=0
 objectUpdated is called to notify an observer when an object registered with the Admin interface was updated. More...
 
- Public Member Functions inherited from Ice::Object
virtual bool ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
 Dispatches an invocation to a servant. More...
 
virtual std::string ice_id (const Current &current) const
 Returns the Slice type ID of the most-derived interface supported by this object. More...
 
virtual std::vector< std::string > ice_ids (const Current &current) const
 Returns the Slice type IDs of the interfaces supported by this object. More...
 
virtual bool ice_isA (std::string s, const Current &current) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual void ice_ping (const Current &current) const
 Tests whether this object can be reached. More...
 
virtual ~Object ()=default
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID corresponding to this class. More...
 
- Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type. More...
 

Detailed Description

This interface allows applications to monitor IceGrid well-known objects.

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ ice_id()

virtual ::std::string IceGrid::ObjectObserver::ice_id ( const ::Ice::Current current) const
override

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.

◆ ice_ids()

virtual ::std::vector<::std::string> IceGrid::ObjectObserver::ice_ids ( const ::Ice::Current current) const
override

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 IceGrid::ObjectObserver::ice_isA ( ::std::string  id,
const ::Ice::Current current 
) const
overridevirtual

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.

◆ ice_staticId()

static const ::std::string& IceGrid::ObjectObserver::ice_staticId ( )
static

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

◆ objectAdded()

virtual void IceGrid::ObjectObserver::objectAdded ( ObjectInfo  info,
const ::Ice::Current current 
)
pure virtual

The objectAdded operation is called to notify an observer when an object was added to the Admin interface.

Parameters
infoThe details of the added object.
currentThe Current object for the invocation.

◆ objectInit()

virtual void IceGrid::ObjectObserver::objectInit ( ObjectInfoSeq  objects,
const ::Ice::Current current 
)
pure virtual

objectInit is called after the registration of an observer to indicate the state of the registry.

Parameters
objectsThe objects registered with the Admin interface (not through the deployment mechanism).
currentThe Current object for the invocation.

◆ objectRemoved()

virtual void IceGrid::ObjectObserver::objectRemoved ( ::Ice::Identity  id,
const ::Ice::Current current 
)
pure virtual

objectRemoved is called to notify an observer when an object registered with the Admin interface was removed.

Parameters
idThe identity of the removed object.
currentThe Current object for the invocation.

◆ objectUpdated()

virtual void IceGrid::ObjectObserver::objectUpdated ( ObjectInfo  info,
const ::Ice::Current current 
)
pure virtual

objectUpdated is called to notify an observer when an object registered with the Admin interface was updated.

Parameters
infoThe details of the updated object.
currentThe Current object for the invocation.

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