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

#include <Ice/Ice.h>

Inheritance diagram for Ice::PropertiesAdminPrx:

Collaboration diagram for Ice::PropertiesAdminPrx:

Public Member Functions
PropertyDict	getPropertiesForPrefix (const ::std::string &prefix, const Context &context=noExplicitContext)
	Get all properties whose keys begin with prefix. More...

::std::function< void()>	getPropertiesForPrefixAsync (const ::std::string &prefix, ::std::function< void(::Ice::PropertyDict)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Get all properties whose keys begin with prefix. More...

template<template< typename > class P = ::std::promise>
auto	getPropertiesForPrefixAsync (const ::std::string &prefix, const Context &context=noExplicitContext) -> decltype(::std::declval< P<::Ice::PropertyDict >>().get_future())
	Get all properties whose keys begin with prefix. More...

::std::string	getProperty (const ::std::string &key, const Context &context=noExplicitContext)
	Get a property by key. More...

::std::function< void()>	getPropertyAsync (const ::std::string &key, ::std::function< void(::std::string)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Get a property by key. More...

template<template< typename > class P = ::std::promise>
auto	getPropertyAsync (const ::std::string &key, const Context &context=noExplicitContext) -> decltype(::std::declval< P<::std::string >>().get_future())
	Get a property by key. More...

void	setProperties (const PropertyDict &newProperties, const Context &context=noExplicitContext)
	Update the communicator's properties with the given property set. More...

::std::function< void()>	setPropertiesAsync (const PropertyDict &newProperties, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Update the communicator's properties with the given property set. More...

template<template< typename > class P = ::std::promise>
auto	setPropertiesAsync (const PropertyDict &newProperties, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Update the communicator's properties with the given property set. More...

Public Member Functions inherited from Ice::Proxy< PropertiesAdminPrx, ObjectPrx >
::std::shared_ptr< PropertiesAdminPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...

::std::shared_ptr< PropertiesAdminPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface. More...

Detailed Description

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

Member Function Documentation

◆ getPropertiesForPrefix()

PropertyDict Ice::PropertiesAdminPrx::getPropertiesForPrefix	(	const ::std::string &	prefix,
		const Context &	context = `noExplicitContext`
	)

inline

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).
context	The Context map to send with the invocation.

Returns: The matching property set.

◆ getPropertiesForPrefixAsync() [1/2]

::std::function<void()> Ice::PropertiesAdminPrx::getPropertiesForPrefixAsync	(	const ::std::string &	prefix,
		::std::function< void(::Ice::PropertyDict)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

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).
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ getPropertiesForPrefixAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::PropertiesAdminPrx::getPropertiesForPrefixAsync	(	const ::std::string &	prefix,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<::Ice::PropertyDict>>().get_future())

inline

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).
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ getProperty()

::std::string Ice::PropertiesAdminPrx::getProperty	(	const ::std::string &	key,
		const Context &	context = `noExplicitContext`
	)

inline

Get a property by key.

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

Parameters

key	The property key.
context	The Context map to send with the invocation.

Returns: The property value.

◆ getPropertyAsync() [1/2]

::std::function<void()> Ice::PropertiesAdminPrx::getPropertyAsync	(	const ::std::string &	key,
		::std::function< void(::std::string)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Get a property by key.

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

Parameters

key	The property key.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ getPropertyAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::PropertiesAdminPrx::getPropertyAsync	(	const ::std::string &	key,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<::std::string>>().get_future())

inline

Get a property by key.

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

Parameters

key	The property key.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

static const ::std::string& Ice::PropertiesAdminPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ setProperties()

void Ice::PropertiesAdminPrx::setProperties	(	const PropertyDict &	newProperties,
		const Context &	context = `noExplicitContext`
	)

inline

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.
context	The Context map to send with the invocation.

◆ setPropertiesAsync() [1/2]

::std::function<void()> Ice::PropertiesAdminPrx::setPropertiesAsync	(	const PropertyDict &	newProperties,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ setPropertiesAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::PropertiesAdminPrx::setPropertiesAsync	(	const PropertyDict &	newProperties,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getPropertiesForPrefix()

◆ getPropertiesForPrefixAsync() [1/2]

◆ getPropertiesForPrefixAsync() [2/2]

◆ getProperty()

◆ getPropertyAsync() [1/2]

◆ getPropertyAsync() [2/2]

◆ ice_staticId()

◆ setProperties()

◆ setPropertiesAsync() [1/2]

◆ setPropertiesAsync() [2/2]