Ice::PropertiesAdminUpdateCallback Class Reference

An application can be notified when its configuration properties are modified via the Properties admin facet. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::PropertiesAdminUpdateCallback:

Collaboration diagram for Ice::PropertiesAdminUpdateCallback:

Public Member Functions
virtual void	updated (const PropertyDict &d)=0
	Called when the communicator's properties have been updated.
virtual	~PropertiesAdminUpdateCallback ()
Public Member Functions inherited from Ice::LocalObject
virtual bool	operator< (const LocalObject &) const
virtual bool	operator== (const LocalObject &) 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)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

An application can be notified when its configuration properties are modified via the Properties admin facet.

The application must define a subclass of PropertiesAdminUpdateCallback and register it with the facet. The facet implements the class NativePropertiesAdmin, so the application needs to downcast the facet to this type in order to register the callback.

For example:

Ice::ObjectPtr obj = communicator->findAdminFacet("Properties");
assert(obj); // May be null if the facet is not enabled
NativePropertiesAdminPtr facet = NativePropertiesAdminPtr::dynamicCast(obj);
PropertiesAdminUpdateCallbackPtr myCallback = ...;
facet->addUpdateCallback(myCallback);

Ice ignores any exceptions raised by the callback.

Constructor & Destructor Documentation

~PropertiesAdminUpdateCallback()

virtual Ice::PropertiesAdminUpdateCallback::~PropertiesAdminUpdateCallback ( )

virtual

Member Function Documentation

updated()

virtual void Ice::PropertiesAdminUpdateCallback::updated ( const PropertyDict & d )

pure virtual

Called when the communicator's properties have been updated.

Parameters

d	A dictionary containing the properties that were added, changed or removed, with a removed property denoted by an entry whose value is an empty string.

---

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

• Ice/NativePropertiesAdmin.h