Ice.PropertiesAdmin

class Ice.PropertiesAdmin

Bases: Object, ABC

Provides remote access to the properties of a communicator.

Notes

The Slice compiler generated this skeleton class from Slice interface ::Ice::PropertiesAdmin.

static ice_staticId() → str

Returns the type ID of the associated Slice interface.

Returns:

The return value is always "::Ice::Object".

Return type:

str

abstractmethod getProperty(key: str, current: Current) → str | Awaitable[str]

Gets a property by key.

Parameters:

  • key (str) – The property key.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

The property value. This value is empty if the property is not set.

Return type:

str | Awaitable[str]

abstractmethod getPropertiesForPrefix(prefix: str, current: Current) → Mapping[str, str] | Awaitable[Mapping[str, str]]

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

  • prefix (str) – The prefix to search for. May be empty.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

The matching property set.

Return type:

Mapping[str, str] | Awaitable[Mapping[str, str]]

abstractmethod setProperties(newProperties: dict[str, str], current: Current) → None | Awaitable[None]

Updates the communicator’s properties with the given property set. 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 the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

  • newProperties (dict[str, str]) – Properties to add, change, or remove.

  • current (Ice.Current) – The Current object for the dispatch.

Returns:

None or an awaitable that completes when the dispatch completes.

Return type:

None | Awaitable[None]