Provides remote access to the properties of a communicator. More...
#include <Ice/Ice.h>
Public Member Functions | |
PropertiesAdminPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString) | |
Constructs a proxy from a Communicator and a proxy string. | |
PropertiesAdminPrx (const PropertiesAdminPrx &other) noexcept | |
Copy constructor. | |
PropertiesAdminPrx (PropertiesAdminPrx &&other) noexcept | |
Move constructor. | |
PropertyDict | getPropertiesForPrefix (std::string_view prefix, const Ice::Context &context=Ice::noExplicitContext) const |
Gets all properties whose keys begin with prefix . | |
std::future< PropertyDict > | getPropertiesForPrefixAsync (std::string_view prefix, const Ice::Context &context=Ice::noExplicitContext) const |
Gets all properties whose keys begin with prefix . | |
std::function< void()> | getPropertiesForPrefixAsync (std::string_view prefix, std::function< void(::Ice::PropertyDict)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const |
Gets all properties whose keys begin with prefix . | |
std::string | getProperty (std::string_view key, const Ice::Context &context=Ice::noExplicitContext) const |
Gets a property by key. | |
std::future< std::string > | getPropertyAsync (std::string_view key, const Ice::Context &context=Ice::noExplicitContext) const |
Gets a property by key. | |
std::function< void()> | getPropertyAsync (std::string_view key, std::function< void(std::string)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const |
Gets a property by key. | |
PropertiesAdminPrx & | operator= (const PropertiesAdminPrx &rhs) noexcept |
Copy assignment operator. | |
PropertiesAdminPrx & | operator= (PropertiesAdminPrx &&rhs) noexcept |
Move assignment operator. | |
void | setProperties (const PropertyDict &newProperties, const Ice::Context &context=Ice::noExplicitContext) const |
Updates the communicator's properties with the given property set. | |
std::future< void > | setPropertiesAsync (const PropertyDict &newProperties, const Ice::Context &context=Ice::noExplicitContext) const |
Updates the communicator's properties with the given property set. | |
std::function< void()> | setPropertiesAsync (const PropertyDict &newProperties, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const |
Updates the communicator's properties with the given property set. | |
Public Member Functions inherited from Ice::Proxy< PropertiesAdminPrx, Ice::ObjectPrx > | |
PropertiesAdminPrx | ice_adapterId (std::string id) const |
Creates a proxy that is identical to this proxy, except for the adapter ID. | |
PropertiesAdminPrx | ice_batchDatagram () const |
Creates a proxy that is identical to this proxy, but uses batch datagram invocations. | |
PropertiesAdminPrx | ice_batchOneway () const |
Creates a proxy that is identical to this proxy, but uses batch oneway invocations. | |
PropertiesAdminPrx | ice_collocationOptimized (bool b) const |
Creates a proxy that is identical to this proxy, except for collocation optimization. | |
PropertiesAdminPrx | ice_compress (bool b) const |
Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. | |
PropertiesAdminPrx | ice_connectionCached (bool b) const |
Creates a proxy that is identical to this proxy, except for connection caching. | |
PropertiesAdminPrx | ice_connectionId (std::string id) const |
Creates a proxy that is identical to this proxy, except for its connection ID. | |
PropertiesAdminPrx | ice_context (Context context) const |
Creates a proxy that is identical to this proxy, except for the per-proxy context. | |
PropertiesAdminPrx | ice_datagram () const |
Creates a proxy that is identical to this proxy, but uses datagram invocations. | |
PropertiesAdminPrx | ice_encodingVersion (EncodingVersion version) const |
Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters. | |
PropertiesAdminPrx | ice_endpoints (EndpointSeq endpoints) const |
Creates a proxy that is identical to this proxy, except for the endpoints. | |
PropertiesAdminPrx | ice_endpointSelection (EndpointSelectionType type) const |
Creates a proxy that is identical to this proxy, except for the endpoint selection policy. | |
PropertiesAdminPrx | ice_fixed (ConnectionPtr connection) const |
Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection. | |
PropertiesAdminPrx | ice_invocationTimeout (int timeout) const |
Creates a proxy that is identical to this proxy, except for the invocation timeout. | |
PropertiesAdminPrx | ice_locator (const std::optional< LocatorPrx > &locator) const |
Creates a proxy that is identical to this proxy, except for the locator. | |
PropertiesAdminPrx | ice_locatorCacheTimeout (int timeout) const |
Creates a proxy that is identical to this proxy, except for the locator cache timeout. | |
PropertiesAdminPrx | ice_oneway () const |
Creates a proxy that is identical to this proxy, but uses oneway invocations. | |
PropertiesAdminPrx | ice_router (const std::optional< RouterPrx > &router) const |
Creates a proxy that is identical to this proxy, except for the router. | |
PropertiesAdminPrx | ice_twoway () const |
Creates a proxy that is identical to this proxy, but uses twoway invocations. | |
const PropertiesAdminPrx * | operator-> () const noexcept |
The arrow operator. |
Static Public Member Functions | |
static const char * | ice_staticId () noexcept |
Gets the type ID of the associated Slice interface. |
Provides remote access to the properties of a communicator.
Definition at line 31 of file PropertiesAdmin.h.