Interface AsyncPropertiesAdmin

Namespace

Ice

Assembly

Ice.dll

Provides remote access to the properties of a communicator.

[SliceTypeId("::Ice::PropertiesAdmin")]
public interface AsyncPropertiesAdmin : Object

Inherited Members

Object.dispatchAsync(IncomingRequest)

Object.ice_isA(string, Current)

Object.ice_ping(Current)

Object.ice_ids(Current)

Object.ice_id(Current)

Object.ice_staticId()

Remarks

This Async interface maps each Slice operation to an asynchronous method that returns a Task. Your servant class implements this interface by deriving fromAsyncPropertiesAdminDisp_ or from the Disp_ class for a derived interface. The Slice compiler generated this skeleton interface from Slice interface ::Ice::PropertiesAdmin.

Methods

getPropertiesForPrefixAsync(string, Current)

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

Task<Dictionary<string, string>> getPropertiesForPrefixAsync(string prefix, Current current)

Parameters

prefix string

The prefix to search for. May be empty.

current Current

The Current object for the dispatch.

Returns

Task<Dictionary<string, string>>

The matching property set.

getPropertyAsync(string, Current)

Gets a property by key.

Task<string> getPropertyAsync(string key, Current current)

Parameters

key string

The property key.

current Current

The Current object for the dispatch.

Returns

Task<string>

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

setPropertiesAsync(Dictionary<string, string>, Current)

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.

Task setPropertiesAsync(Dictionary<string, string> newProperties, Current current)

Parameters

newProperties Dictionary<string, string>

Properties to add, change, or remove.

current Current

The Current object for the dispatch.

Returns

Task

A task that completes when the dispatch completes.