Class SessionPrxHelper

Namespace

IceGrid

Assembly

IceGrid.dll

Helper class for proxy SessionPrx.

public sealed class SessionPrxHelper : ObjectPrxHelperBase, SessionPrx, SessionPrx, ObjectPrx, IEquatable<ObjectPrx>

Inheritance

object

ObjectPrxHelperBase

SessionPrxHelper

Implements

SessionPrx

SessionPrx

ObjectPrx

IEquatable<ObjectPrx>

Inherited Members

ObjectPrxHelperBase.Equals(ObjectPrx)

ObjectPrxHelperBase.Equals(object)

ObjectPrxHelperBase.GetHashCode()

ObjectPrxHelperBase.ice_getCommunicator()

ObjectPrxHelperBase.ToString()

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

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

ObjectPrxHelperBase.ice_ping(Dictionary<string, string>)

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

ObjectPrxHelperBase.ice_ids(Dictionary<string, string>)

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

ObjectPrxHelperBase.ice_id(Dictionary<string, string>)

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

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

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

ObjectPrxHelperBase.ice_getIdentity()

ObjectPrxHelperBase.ice_identity(Identity)

ObjectPrxHelperBase.ice_getContext()

ObjectPrxHelperBase.ice_context(Dictionary<string, string>)

ObjectPrxHelperBase.ice_getFacet()

ObjectPrxHelperBase.ice_facet(string)

ObjectPrxHelperBase.ice_getAdapterId()

ObjectPrxHelperBase.ice_adapterId(string)

ObjectPrxHelperBase.ice_getEndpoints()

ObjectPrxHelperBase.ice_endpoints(Endpoint[])

ObjectPrxHelperBase.ice_getLocatorCacheTimeout()

ObjectPrxHelperBase.ice_locatorCacheTimeout(int)

ObjectPrxHelperBase.ice_locatorCacheTimeout(TimeSpan)

ObjectPrxHelperBase.ice_getInvocationTimeout()

ObjectPrxHelperBase.ice_invocationTimeout(int)

ObjectPrxHelperBase.ice_invocationTimeout(TimeSpan)

ObjectPrxHelperBase.ice_isConnectionCached()

ObjectPrxHelperBase.ice_connectionCached(bool)

ObjectPrxHelperBase.ice_getEndpointSelection()

ObjectPrxHelperBase.ice_endpointSelection(EndpointSelectionType)

ObjectPrxHelperBase.ice_encodingVersion(EncodingVersion)

ObjectPrxHelperBase.ice_getEncodingVersion()

ObjectPrxHelperBase.ice_getRouter()

ObjectPrxHelperBase.ice_router(RouterPrx)

ObjectPrxHelperBase.ice_getLocator()

ObjectPrxHelperBase.ice_locator(LocatorPrx)

ObjectPrxHelperBase.ice_isCollocationOptimized()

ObjectPrxHelperBase.ice_collocationOptimized(bool)

ObjectPrxHelperBase.ice_twoway()

ObjectPrxHelperBase.ice_isTwoway()

ObjectPrxHelperBase.ice_oneway()

ObjectPrxHelperBase.ice_isOneway()

ObjectPrxHelperBase.ice_batchOneway()

ObjectPrxHelperBase.ice_isBatchOneway()

ObjectPrxHelperBase.ice_datagram()

ObjectPrxHelperBase.ice_isDatagram()

ObjectPrxHelperBase.ice_batchDatagram()

ObjectPrxHelperBase.ice_isBatchDatagram()

ObjectPrxHelperBase.ice_compress(bool)

ObjectPrxHelperBase.ice_getCompress()

ObjectPrxHelperBase.ice_connectionId(string)

ObjectPrxHelperBase.ice_getConnectionId()

ObjectPrxHelperBase.ice_fixed(Connection)

ObjectPrxHelperBase.ice_isFixed()

ObjectPrxHelperBase.ice_getConnection()

ObjectPrxHelperBase.ice_getConnectionAsync(IProgress<bool>, CancellationToken)

ObjectPrxHelperBase.ice_getCachedConnection()

ObjectPrxHelperBase.ice_flushBatchRequests()

ObjectPrxHelperBase.ice_flushBatchRequestsAsync(IProgress<bool>, CancellationToken)

ObjectPrxHelperBase.ice_scheduler()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

The Slice compiler generated this proxy helper class from Slice interface ::IceGrid::Session.

Methods

allocateObjectById(Identity, Dictionary<string, string>?)

Allocates an object.

public ObjectPrx? allocateObjectById(Identity id, Dictionary<string, string>? context = null)

Parameters

id Identity

The identity of the object to allocate.

context Dictionary<string, string>

The request context.

Returns

ObjectPrx

A proxy to the allocated object. This proxy is never null.

Exceptions

AllocationException

Thrown when the allocation fails.

ObjectNotRegisteredException

Thrown when an object with the given identity is not registered with the registry.

See Also

setAllocationTimeoutAsync(int, Dictionary<string, string>, IProgress<bool>, CancellationToken)

releaseObjectAsync(Identity, Dictionary<string, string>, IProgress<bool>, CancellationToken)

allocateObjectByIdAsync(Identity, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Allocates an object.

public Task<ObjectPrx?> allocateObjectByIdAsync(Identity id, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

id Identity

The identity of the object to allocate.

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<ObjectPrx>

A proxy to the allocated object. This proxy is never null.

Exceptions

AllocationException

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

ObjectNotRegisteredException

Thrown when an object with the given identity is not registered with the registry. This exception is provided through the returned task; it's never thrown synchronously.

See Also

setAllocationTimeoutAsync(int, Dictionary<string, string>, IProgress<bool>, CancellationToken)

releaseObjectAsync(Identity, Dictionary<string, string>, IProgress<bool>, CancellationToken)

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

Allocates an object with the given type.

public ObjectPrx? allocateObjectByType(string type, Dictionary<string, string>? context = null)

Parameters

type string

The type of the object.

context Dictionary<string, string>

The request context.

Returns

ObjectPrx

A proxy to the allocated object. This proxy is never null.

Exceptions

AllocationException

Thrown when the allocation fails.

See Also

setAllocationTimeoutAsync(int, Dictionary<string, string>, IProgress<bool>, CancellationToken)

releaseObjectAsync(Identity, Dictionary<string, string>, IProgress<bool>, CancellationToken)

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

Allocates an object with the given type.

public Task<ObjectPrx?> allocateObjectByTypeAsync(string type, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

type string

The type of the object.

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<ObjectPrx>

A proxy to the allocated object. This proxy is never null.

Exceptions

AllocationException

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

See Also

setAllocationTimeoutAsync(int, Dictionary<string, string>, IProgress<bool>, CancellationToken)

releaseObjectAsync(Identity, Dictionary<string, string>, IProgress<bool>, CancellationToken)

checkedCast(ObjectPrx?, Dictionary<string, string>?)

Creates a new SessionPrx from an existing proxy after checking that the target object implements Slice interface Session.

public static SessionPrx? checkedCast(ObjectPrx? proxy, Dictionary<string, string>? context = null)

Parameters

proxy ObjectPrx

The source proxy.

context Dictionary<string, string>

The request context.

Returns

SessionPrx

A new proxy with the requested type, or null if the target object does not implement Slice interface Session.

checkedCast(ObjectPrx?, string, Dictionary<string, string>?)

Creates a new SessionPrx from an existing proxy after checking that the target facet implements Slice interface Session.

public static SessionPrx? checkedCast(ObjectPrx? proxy, string facet, Dictionary<string, string>? context = null)

Parameters

proxy ObjectPrx

The source proxy.

facet string

The facet.

context Dictionary<string, string>

The request context.

Returns

SessionPrx

A new proxy with the requested type, or null if the target facet does not implement Slice interface Session.

checkedCastAsync(ObjectPrx, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Creates a new SessionPrx from an existing proxy after checking that the target object implements Slice interface Session.

public static Task<SessionPrx?> checkedCastAsync(ObjectPrx proxy, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

proxy ObjectPrx

The source proxy.

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress reporter.

cancel CancellationToken

The cancellation token.

Returns

Task<SessionPrx>

A new proxy with the requested type, or null if the target object does not implement Slice interface Session.

checkedCastAsync(ObjectPrx, string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Creates a new SessionPrx from an existing proxy after checking that the target facet implements Slice interface Session.

public static Task<SessionPrx?> checkedCastAsync(ObjectPrx proxy, string facet, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

proxy ObjectPrx

The source proxy.

facet string

The facet.

context Dictionary<string, string>

The request context.

progress IProgress<bool>

The sent progress reporter.

cancel CancellationToken

The cancellation token.

Returns

Task<SessionPrx>

A new proxy with the requested type, or null if the target facet does not implement Slice interface Session.

createProxy(Communicator, string)

Creates a new proxy from a communicator and a proxy string.

public static SessionPrx createProxy(Communicator communicator, string proxyString)

Parameters

communicator Communicator

The communicator.

proxyString string

The stringified proxy.

Returns

SessionPrx

A new proxy.

destroy(Dictionary<string, string>?)

Destroys this session.

public void destroy(Dictionary<string, string>? context = null)

Parameters

context Dictionary<string, string>

The request context.

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

Destroys this session.

public Task destroyAsync(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

For two-way invocations: a task that completes when the response is received. For one-way invocations: a task that completes when the request is sent.

ice_staticId()

Gets the type ID of the associated Slice interface.

public static string ice_staticId()

Returns

string

The string ::IceGrid::Session.

keepAlive(Dictionary<string, string>?)

Keeps the session alive.

public void keepAlive(Dictionary<string, string>? context = null)

Parameters

context Dictionary<string, string>

The request context.

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

Keeps the session alive.

public Task keepAliveAsync(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

For two-way invocations: a task that completes when the response is received. For one-way invocations: a task that completes when the request is sent.

read(InputStream)

Unmarshals a value from an input stream.

public static SessionPrx? read(InputStream istr)

Parameters

istr InputStream

The input stream.

Returns

SessionPrx

The unmarshaled value.

releaseObject(Identity, Dictionary<string, string>?)

Releases an object that was allocated using allocateObjectByIdAsync(Identity, Dictionary<string, string>?, IProgress<bool>?, CancellationToken) or allocateObjectByTypeAsync(string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken).

public void releaseObject(Identity id, Dictionary<string, string>? context = null)

Parameters

id Identity

The identity of the object to release.

context Dictionary<string, string>

The request context.

Exceptions

AllocationException

Thrown when the object can't be released. This can happen when the object is not allocatable or is not allocated by this session.

ObjectNotRegisteredException

Thrown when an object with the given identity is not registered with the registry.

releaseObjectAsync(Identity, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Releases an object that was allocated using allocateObjectByIdAsync(Identity, Dictionary<string, string>?, IProgress<bool>?, CancellationToken) or allocateObjectByTypeAsync(string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken).

public Task releaseObjectAsync(Identity id, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

id Identity

The identity of the object to release.

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

A task that completes when the response is received.

Exceptions

AllocationException

Thrown when the object can't be released. This can happen when the object is not allocatable or is not allocated by this session. This exception is provided through the returned task; it's never thrown synchronously.

ObjectNotRegisteredException

Thrown when an object with the given identity is not registered with the registry. This exception is provided through the returned task; it's never thrown synchronously.

setAllocationTimeout(int, Dictionary<string, string>?)

Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation of allocateObjectByIdAsync(Identity, Dictionary<string, string>?, IProgress<bool>?, CancellationToken) and allocateObjectByTypeAsync(string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken) waits for the duration of this timeout.

public void setAllocationTimeout(int timeout, Dictionary<string, string>? context = null)

Parameters

timeout int

The timeout in milliseconds.

context Dictionary<string, string>

The request context.

setAllocationTimeoutAsync(int, Dictionary<string, string>?, IProgress<bool>?, CancellationToken)

Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation of allocateObjectByIdAsync(Identity, Dictionary<string, string>?, IProgress<bool>?, CancellationToken) and allocateObjectByTypeAsync(string, Dictionary<string, string>?, IProgress<bool>?, CancellationToken) waits for the duration of this timeout.

public Task setAllocationTimeoutAsync(int timeout, Dictionary<string, string>? context = null, IProgress<bool>? progress = null, CancellationToken cancel = default)

Parameters

timeout int

The timeout in milliseconds.

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

For two-way invocations: a task that completes when the response is received. For one-way invocations: a task that completes when the request is sent.

uncheckedCast(ObjectPrx?)

Creates a new SessionPrx from an existing proxy.

public static SessionPrx? uncheckedCast(ObjectPrx? proxy)

Parameters

proxy ObjectPrx

The source proxy.

Returns

SessionPrx

A new proxy with the requested type, or null if the source proxy is null.

uncheckedCast(ObjectPrx?, string)

Creates a new SessionPrx from an existing proxy after changing its facet.

public static SessionPrx? uncheckedCast(ObjectPrx? proxy, string facet)

Parameters

proxy ObjectPrx

The source proxy.

facet string

The facet.

Returns

SessionPrx

A new proxy with the requested type, or null if the source proxy is null.

write(OutputStream, SessionPrx?)

Marshals a value into an output stream.

public static void write(OutputStream ostr, SessionPrx? v)

Parameters

ostr OutputStream

The output stream.

v SessionPrx

The value to marshal.