The PropertiesAdmin interface provides remote access to the properties of a communicator. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::PropertiesAdmin:

[legend]

Collaboration diagram for Ice::PropertiesAdmin:

[legend]

Public Types
typedef PropertiesAdminPtr	PointerType
typedef PropertiesAdminPrx	ProxyType

Public Member Functions
virtual PropertyDict	getPropertiesForPrefix (const ::std::string &prefix, const Current &current=emptyCurrent)=0
	Get all properties whose keys begin with prefix.
virtual::std::string	getProperty (const ::std::string &key, const Current &current=emptyCurrent)=0
	Get a property by key.
virtual const ::std::string &	ice_id (const Current &current=emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string >	ice_ids (const Current &current=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 Current &current=emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID.
virtual void	setProperties (const PropertyDict &newProperties, const Current &current=emptyCurrent)=0
	Update the communicator's properties with the given property set.
virtual	~PropertiesAdmin ()
Public Member Functions inherited from Ice::Object
virtual ObjectPtr	ice_clone () const
	Returns a shallow copy of the 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 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)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Static Public Member Functions
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.

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

The PropertiesAdmin interface provides remote access to the properties of a communicator.

Member Typedef Documentation

◆ PointerType

typedef PropertiesAdminPtr Ice::PropertiesAdmin::PointerType

◆ ProxyType

typedef PropertiesAdminPrx Ice::PropertiesAdmin::ProxyType

Constructor & Destructor Documentation

◆ ~PropertiesAdmin()

virtual Ice::PropertiesAdmin::~PropertiesAdmin ( )

virtual

Member Function Documentation

◆ getPropertiesForPrefix()

virtual PropertyDict Ice::PropertiesAdmin::getPropertiesForPrefix	(	const ::std::string &	prefix,
		const Current &	current = emptyCurrent )

pure virtual

Get all properties whose keys begin with prefix.

If prefix is an empty string then all properties are returned.

Parameters

prefix	The prefix to search for (empty string if none).
current	The Current object for the invocation.

Returns: The matching property set.

◆ getProperty()

virtual::std::string Ice::PropertiesAdmin::getProperty	(	const ::std::string &	key,
		const Current &	current = emptyCurrent )

pure virtual

Get a property by key.

If the property is not set, an empty string is returned.

Parameters

key	The property key.
current	The Current object for the invocation.

Returns: The property value.

◆ ice_id()

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

virtual

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.

Reimplemented from Ice::Object.

◆ ice_ids()

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

virtual

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.

Reimplemented from Ice::Object.

◆ ice_isA()

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

virtual

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()

const ::std::string & Ice::PropertiesAdmin::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ setProperties()

virtual void Ice::PropertiesAdmin::setProperties	(	const PropertyDict &	newProperties,
		const Current &	current = emptyCurrent )

pure virtual

Update the communicator's properties with the given property set.

Parameters

newProperties	Properties to be added, changed, or removed. If an entry in newProperties matches the name of an existing property, that property's value is replaced with the new value. If the new value is an empty string, the property is removed. Any existing properties that are not modified or removed by the entries in newProperties are retained with their original values.
current	The Current object for the invocation.

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

generated/cpp98/x64/Release/Ice/PropertiesAdmin.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~PropertiesAdmin()

Member Function Documentation

◆ getPropertiesForPrefix()

◆ getProperty()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ setProperties()