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

The database observer interface. More...

#include <IceGrid/IceGrid.h>

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

Public Types

using ProxyType = ApplicationObserverPrx
 

Public Member Functions

virtual void applicationAdded (int serial, ApplicationInfo desc, const ::Ice::Current &current)=0
 The applicationAdded operation is called to notify an observer that an application was added. More...
 
virtual void applicationInit (int serial, ApplicationInfoSeq applications, const ::Ice::Current &current)=0
 applicationInit is called after the registration of an observer to indicate the state of the registry. More...
 
virtual void applicationRemoved (int serial, ::std::string name, const ::Ice::Current &current)=0
 The applicationRemoved operation is called to notify an observer that an application was removed. More...
 
virtual void applicationUpdated (int serial, ApplicationUpdateInfo desc, const ::Ice::Current &current)=0
 The applicationUpdated operation is called to notify an observer that an application was updated. More...
 
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...
 
- 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

The database observer interface.

Observers should implement this interface to receive information about the state of the IceGrid registry database.

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ applicationAdded()

virtual void IceGrid::ApplicationObserver::applicationAdded ( int  serial,
ApplicationInfo  desc,
const ::Ice::Current current 
)
pure virtual

The applicationAdded operation is called to notify an observer that an application was added.

Parameters
serialThe new serial number of the registry database.
descThe descriptor of the new application.
currentThe Current object for the invocation.

◆ applicationInit()

virtual void IceGrid::ApplicationObserver::applicationInit ( int  serial,
ApplicationInfoSeq  applications,
const ::Ice::Current current 
)
pure virtual

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

Parameters
serialThe current serial number of the registry database. This serial number allows observers to make sure that their internal state is synchronized with the registry.
applicationsThe applications currently registered with the registry.
currentThe Current object for the invocation.

◆ applicationRemoved()

virtual void IceGrid::ApplicationObserver::applicationRemoved ( int  serial,
::std::string  name,
const ::Ice::Current current 
)
pure virtual

The applicationRemoved operation is called to notify an observer that an application was removed.

Parameters
serialThe new serial number of the registry database.
nameThe name of the application that was removed.
currentThe Current object for the invocation.

◆ applicationUpdated()

virtual void IceGrid::ApplicationObserver::applicationUpdated ( int  serial,
ApplicationUpdateInfo  desc,
const ::Ice::Current current 
)
pure virtual

The applicationUpdated operation is called to notify an observer that an application was updated.

Parameters
serialThe new serial number of the registry database.
descThe descriptor of the update.
currentThe Current object for the invocation.

◆ ice_id()

virtual ::std::string IceGrid::ApplicationObserver::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::ApplicationObserver::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::ApplicationObserver::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::ApplicationObserver::ice_staticId ( )
static

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

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