The PropertiesAdmin interface provides remote access to the properties of a communicator.
More...
#include <Ice/Ice.h>
|
virtual PropertyDict | getPropertiesForPrefix (::std::string prefix, const Current ¤t)=0 |
| Get all properties whose keys begin with prefix. More...
|
|
virtual ::std::string | getProperty (::std::string key, const Current ¤t)=0 |
| Get a property by key. More...
|
|
virtual ::std::string | ice_id (const Current ¤t) 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 Current ¤t) 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 Current ¤t) const override |
| Determines whether this object supports an interface with the given Slice type ID. More...
|
|
virtual void | setProperties (PropertyDict newProperties, const Current ¤t)=0 |
| Update the communicator's properties with the given property set. More...
|
|
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 bool | ice_isA (std::string s, const Current ¤t) const |
| Tests whether this object supports a specific Slice interface. More...
|
|
virtual void | ice_ping (const Current ¤t) const |
| Tests whether this object can be reached. More...
|
|
virtual | ~Object ()=default |
|
|
static const ::std::string & | ice_staticId () |
| Obtains the Slice type ID corresponding to this class. More...
|
|
static const std::string & | ice_staticId () |
| Obtains the Slice type ID of this type. More...
|
|
The PropertiesAdmin interface provides remote access to the properties of a communicator.
◆ ProxyType
◆ getPropertiesForPrefix()
virtual PropertyDict Ice::PropertiesAdmin::getPropertiesForPrefix |
( |
::std::string |
prefix, |
|
|
const Current & |
current |
|
) |
| |
|
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 |
( |
::std::string |
key, |
|
|
const Current & |
current |
|
) |
| |
|
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 ::std::string Ice::PropertiesAdmin::ice_id |
( |
const Current & |
current | ) |
const |
|
overridevirtual |
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 | ) |
const |
|
overridevirtual |
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 |
( |
::std::string |
id, |
|
|
const 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& 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 |
( |
PropertyDict |
newProperties, |
|
|
const Current & |
current |
|
) |
| |
|
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: