The node observer interface. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::NodeObserver:

Collaboration diagram for IceGrid::NodeObserver:

Public Types
using	ProxyType = NodeObserverPrx

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	nodeDown (::std::string name, const ::Ice::Current &current)=0
	The `nodeDown` operation is called to notify an observer that a node went down. More...

virtual void	nodeInit (NodeDynamicInfoSeq nodes, const ::Ice::Current &current)=0
	The `nodeInit` operation indicates the current state of nodes. More...

virtual void	nodeUp (NodeDynamicInfo node, const ::Ice::Current &current)=0
	The `nodeUp` operation is called to notify an observer that a node came up. More...

virtual void	updateAdapter (::std::string node, AdapterDynamicInfo updatedInfo, const ::Ice::Current &current)=0
	The `updateAdapter` operation is called to notify an observer that the state of an adapter changed. More...

virtual void	updateServer (::std::string node, ServerDynamicInfo updatedInfo, const ::Ice::Current &current)=0
	The `updateServer` operation is called to notify an observer that the state of a server changed. 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 node observer interface.

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

Member Typedef Documentation

◆ ProxyType

using IceGrid::NodeObserver::ProxyType = NodeObserverPrx

Member Function Documentation

◆ ice_id()

virtual ::std::string IceGrid::NodeObserver::ice_id ( const ::Ice::Current & current ) const

override

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

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector<::std::string> IceGrid::NodeObserver::ice_ids ( const ::Ice::Current & current ) const

override

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

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::NodeObserver::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

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

◆ ice_staticId()

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

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ nodeDown()

virtual void IceGrid::NodeObserver::nodeDown	(	::std::string	name,
		const ::Ice::Current &	current
	)

pure virtual

The nodeDown operation is called to notify an observer that a node went down.

Parameters

name	The node name.
current	The Current object for the invocation.

◆ nodeInit()

virtual void IceGrid::NodeObserver::nodeInit	(	NodeDynamicInfoSeq	nodes,
		const ::Ice::Current &	current
	)

pure virtual

The nodeInit operation indicates the current state of nodes.

It is called after the registration of an observer.

Parameters

nodes	The current state of the nodes.
current	The Current object for the invocation.

◆ nodeUp()

virtual void IceGrid::NodeObserver::nodeUp	(	NodeDynamicInfo	node,
		const ::Ice::Current &	current
	)

pure virtual

The nodeUp operation is called to notify an observer that a node came up.

Parameters

node	The node state.
current	The Current object for the invocation.

◆ updateAdapter()

virtual void IceGrid::NodeObserver::updateAdapter	(	::std::string	node,
		AdapterDynamicInfo	updatedInfo,
		const ::Ice::Current &	current
	)

pure virtual

The updateAdapter operation is called to notify an observer that the state of an adapter changed.

Parameters

node	The node hosting the adapter.
updatedInfo	The new adapter state.
current	The Current object for the invocation.

◆ updateServer()

virtual void IceGrid::NodeObserver::updateServer	(	::std::string	node,
		ServerDynamicInfo	updatedInfo,
		const ::Ice::Current &	current
	)

pure virtual

The updateServer operation is called to notify an observer that the state of a server changed.

Parameters

node	The node hosting the server.
updatedInfo	The new server state.
current	The Current object for the invocation.

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

generated/cpp11/x64/Release/IceGrid/Admin.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ nodeDown()

◆ nodeInit()

◆ nodeUp()

◆ updateAdapter()

◆ updateServer()