Interface RegistryPrx

Namespace

IceGrid

Assembly

IceGrid.dll

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

public interface RegistryPrx : ObjectPrx, IEquatable<ObjectPrx>

Inherited Members

ObjectPrx.ice_getCommunicator()

ObjectPrx.ice_isA(string, Dictionary<string, string>)

ObjectPrx.ice_isAAsync(string, Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_ping(Dictionary<string, string>)

ObjectPrx.ice_pingAsync(Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_ids(Dictionary<string, string>)

ObjectPrx.ice_idsAsync(Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_id(Dictionary<string, string>)

ObjectPrx.ice_idAsync(Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_invoke(string, OperationMode, byte[], out byte[], Dictionary<string, string>)

ObjectPrx.ice_invokeAsync(string, OperationMode, byte[], Dictionary<string, string>, IProgress<bool>, CancellationToken)

ObjectPrx.ice_getIdentity()

ObjectPrx.ice_identity(Identity)

ObjectPrx.ice_getContext()

ObjectPrx.ice_context(Dictionary<string, string>)

ObjectPrx.ice_getFacet()

ObjectPrx.ice_facet(string)

ObjectPrx.ice_getAdapterId()

ObjectPrx.ice_adapterId(string)

ObjectPrx.ice_getEndpoints()

ObjectPrx.ice_endpoints(Endpoint[])

ObjectPrx.ice_getLocatorCacheTimeout()

ObjectPrx.ice_locatorCacheTimeout(int)

ObjectPrx.ice_locatorCacheTimeout(TimeSpan)

ObjectPrx.ice_invocationTimeout(int)

ObjectPrx.ice_invocationTimeout(TimeSpan)

ObjectPrx.ice_getInvocationTimeout()

ObjectPrx.ice_isConnectionCached()

ObjectPrx.ice_connectionCached(bool)

ObjectPrx.ice_getEndpointSelection()

ObjectPrx.ice_endpointSelection(EndpointSelectionType)

ObjectPrx.ice_encodingVersion(EncodingVersion)

ObjectPrx.ice_getEncodingVersion()

ObjectPrx.ice_getRouter()

ObjectPrx.ice_router(RouterPrx)

ObjectPrx.ice_getLocator()

ObjectPrx.ice_locator(LocatorPrx)

ObjectPrx.ice_isCollocationOptimized()

ObjectPrx.ice_collocationOptimized(bool)

ObjectPrx.ice_twoway()

ObjectPrx.ice_isTwoway()

ObjectPrx.ice_oneway()

ObjectPrx.ice_isOneway()

ObjectPrx.ice_batchOneway()

ObjectPrx.ice_isBatchOneway()

ObjectPrx.ice_datagram()

ObjectPrx.ice_isDatagram()

ObjectPrx.ice_batchDatagram()

ObjectPrx.ice_isBatchDatagram()

ObjectPrx.ice_compress(bool)

ObjectPrx.ice_getCompress()

ObjectPrx.ice_connectionId(string)

ObjectPrx.ice_getConnectionId()

ObjectPrx.ice_fixed(Connection)

ObjectPrx.ice_isFixed()

ObjectPrx.ice_getConnection()

ObjectPrx.ice_getConnectionAsync(IProgress<bool>, CancellationToken)

ObjectPrx.ice_getCachedConnection()

ObjectPrx.ice_flushBatchRequests()

ObjectPrx.ice_flushBatchRequestsAsync(IProgress<bool>, CancellationToken)

ObjectPrx.ice_scheduler()

ObjectPrx.checkNotNull(ObjectPrx, Current)

IEquatable<ObjectPrx>.Equals(ObjectPrx)

Remarks

Use the methods of this interface to invoke operations on a remote Ice object that implements Registry. The Slice compiler generated this proxy interface from Slice interface ::IceGrid::Registry.

Methods

createAdminSession(string, string, Dictionary<string, string>?)

Creates an administrative session.

AdminSessionPrx? createAdminSession(string userId, string password, Dictionary<string, string>? context = null)

Parameters

userId string

The user ID.

password string

The password for the given user.

context Dictionary<string, string>

The request context.

Returns

AdminSessionPrx

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createAdminSessionAsync(string, string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Creates an administrative session.

Task<AdminSessionPrx?> createAdminSessionAsync(string userId, string password, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

userId string

The user ID.

password string

The password for the given user.

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<AdminSessionPrx>

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails. This exception is provided through the returned task; it's never thrown synchronously.

createAdminSessionFromSecureConnection(Dictionary<string, string>?)

Creates an administrative session from a secure connection.

AdminSessionPrx? createAdminSessionFromSecureConnection(Dictionary<string, string>? context = null)

Parameters

context Dictionary<string, string>

The request context.

Returns

AdminSessionPrx

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createAdminSessionFromSecureConnectionAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Creates an administrative session from a secure connection.

Task<AdminSessionPrx?> createAdminSessionFromSecureConnectionAsync(Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<AdminSessionPrx>

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails. This exception is provided through the returned task; it's never thrown synchronously.

createSession(string, string, Dictionary<string, string>?)

Creates a client session.

SessionPrx? createSession(string userId, string password, Dictionary<string, string>? context = null)

Parameters

userId string

The user ID.

password string

The password for the given user.

context Dictionary<string, string>

The request context.

Returns

SessionPrx

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createSessionAsync(string, string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Creates a client session.

Task<SessionPrx?> createSessionAsync(string userId, string password, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

userId string

The user ID.

password string

The password for the given user.

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<SessionPrx>

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails. This exception is provided through the returned task; it's never thrown synchronously.

createSessionFromSecureConnection(Dictionary<string, string>?)

Creates a client session from a secure connection.

SessionPrx? createSessionFromSecureConnection(Dictionary<string, string>? context = null)

Parameters

context Dictionary<string, string>

The request context.

Returns

SessionPrx

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails.

createSessionFromSecureConnectionAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Creates a client session from a secure connection.

Task<SessionPrx?> createSessionFromSecureConnectionAsync(Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<SessionPrx>

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

Exceptions

PermissionDeniedException

Thrown when authentication or authorization fails. This exception is provided through the returned task; it's never thrown synchronously.

getSessionTimeout(Dictionary<string, string>?)

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]
int getSessionTimeout(Dictionary<string, string>? context = null)

Parameters

context Dictionary<string, string>

The request context.

Returns

int

The session timeout (in seconds).

getSessionTimeoutAsync(Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

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(Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress provider.

cancel CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<int>

The session timeout (in seconds).