Interface AsyncRegistry

Namespace

IceGrid

Assembly

IceGrid.dll

Represents the main entry point into the IceGrid registry service. It provides operations to create sessions with the registry.

[SliceTypeId("::IceGrid::Registry")]
public interface AsyncRegistry : 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 fromAsyncRegistryDisp_ or from the Disp_ class for a derived interface. The Slice compiler generated this skeleton interface from Slice interface ::IceGrid::Registry.

Methods

createAdminSessionAsync(string, string, Current)

Creates an administrative session.

Task<AdminSessionPrx?> createAdminSessionAsync(string userId, string password, Current current)

Parameters

userId string

The user ID.

password string

The password for the given user.

current Current

The Current object for the dispatch.

Returns

Task<AdminSessionPrx>

A proxy to the newly created session. This proxy is never null.

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createAdminSessionFromSecureConnectionAsync(Current)

Creates an administrative session from a secure connection.

Task<AdminSessionPrx?> createAdminSessionFromSecureConnectionAsync(Current current)

Parameters

current Current

The Current object for the dispatch.

Returns

Task<AdminSessionPrx>

A proxy to the newly created session. This proxy is never null.

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createSessionAsync(string, string, Current)

Creates a client session.

Task<SessionPrx?> createSessionAsync(string userId, string password, Current current)

Parameters

userId string

The user ID.

password string

The password for the given user.

current Current

The Current object for the dispatch.

Returns

Task<SessionPrx>

A proxy to the newly created session. This proxy is never null.

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createSessionFromSecureConnectionAsync(Current)

Creates a client session from a secure connection.

Task<SessionPrx?> createSessionFromSecureConnectionAsync(Current current)

Parameters

current Current

The Current object for the dispatch.

Returns

Task<SessionPrx>

A proxy to the newly created session. This proxy is never null.

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

getSessionTimeoutAsync(Current)

Gets the session timeout. An Ice 3.7 or earlier client can use this value to determine how often it needs to send heartbeats (using ACM) or call keepAliveAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken) (resp. keepAliveAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken)) to keep a session alive in the IceGrid registry.

[Obsolete]
Task<int> getSessionTimeoutAsync(Current current)

Parameters

current Current

The Current object for the dispatch.

Returns

Task<int>

The session timeout (in seconds).