Class SessionPrx

Represents a session object used by IceGrid clients to allocate and release objects. Client sessions are created either via the IceGrid.RegistryPrx object or via the registry client Glacier2.SessionManagerPrx object.

Remarks

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

Hierarchy (View Summary)

ObjectPrx
- SessionPrx

Implements

Glacier2.SessionPrx

Index

Constructors

constructor

Methods

Constructors

constructor

new SessionPrx(
communicator: Communicator,
proxyString: string,
): IceGrid.SessionPrx
Constructs a new SessionPrx proxy.
Parameters
- communicator: Communicator
  The communicator for the new proxy.
- proxyString: string
  The string representation of the proxy.
Returns IceGrid.SessionPrx
The new SessionPrx proxy.

Throws
ParseException - Thrown if the proxyString is not a valid proxy string.

Overrides ObjectPrx.constructor

Methods

allocateObjectById

allocateObjectById(
id: Identity,
context?: Map<string, string>,
): AsyncResult<ObjectPrx>
Allocates an object.
Parameters
- id: Identity
  The identity of the object to allocate.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectPrx>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- Ice.ObjectPrx | null : A proxy to the allocated object. This proxy is never null.
Throws
IceGrid.AllocationException Thrown when the allocation fails.

Throws
IceGrid.ObjectNotRegisteredException Thrown when an object with the given identity is not registered with the registry.
See
- IceGrid.SessionPrx.setAllocationTimeout
- IceGrid.SessionPrx.releaseObject

allocateObjectByType

allocateObjectByType(
type: string,
context?: Map<string, string>,
): AsyncResult<ObjectPrx>
Allocates an object with the given type.
Parameters
- type: string
  The type of the object.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectPrx>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- Ice.ObjectPrx | null : A proxy to the allocated object. This proxy is never null.
Throws
IceGrid.AllocationException Thrown when the allocation fails.
See
- IceGrid.SessionPrx.setAllocationTimeout
- IceGrid.SessionPrx.releaseObject

destroy

destroy(context?: Map<string, string>): AsyncResult<void>
Destroys this session.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Implementation of SessionPrx.destroy

equals

equals(other: ObjectPrx): boolean
Checks whether the specified object is equal to this object.
Parameters
- other: ObjectPrx
  The object to compare with.
Returns boolean
true if the specified object is equal to this object, false otherwise.

Implementation of SessionPrx.equals
Inherited from ObjectPrx.equals

ice_adapterId

ice_adapterId(id: string): this
Creates a proxy that is identical to this proxy, except for the adapter ID.
Parameters
- id: string
  The adapter ID for the new proxy.
Returns this
A proxy with the new adapter ID.

Implementation of SessionPrx.ice_adapterId
Inherited from ObjectPrx.ice_adapterId

ice_batchOneway

ice_batchOneway(): this
Creates a proxy that is identical to this proxy, but uses batch oneway invocations.

Returns this
A proxy that uses batch oneway invocations.

Implementation of SessionPrx.ice_batchOneway
Inherited from ObjectPrx.ice_batchOneway

ice_connectionCached

ice_connectionCached(cache: boolean): this
Creates a proxy that is identical to this proxy, except for connection caching.
Parameters
- cache: boolean
  true if the new proxy should cache connections, false otherwise.
Returns this
A proxy with the specified caching policy.

Implementation of SessionPrx.ice_connectionCached
Inherited from ObjectPrx.ice_connectionCached

ice_connectionId

ice_connectionId(connectionId: string): this
Creates a proxy that is identical to this proxy, except for its connection ID.
Parameters
- connectionId: string
  The connection ID for the new proxy. An empty string removes the connection ID.
Returns this
A proxy with the specified connection ID.

Implementation of SessionPrx.ice_connectionId
Inherited from ObjectPrx.ice_connectionId

ice_context

ice_context(context: Map<string, string>): this
Creates a proxy that is identical to this proxy, except for the per-proxy context.
Parameters
- context: Map<string, string>
  The context for the new proxy.
Returns this
A proxy with the new per-proxy context.

Implementation of SessionPrx.ice_context
Inherited from ObjectPrx.ice_context

ice_encodingVersion

ice_encodingVersion(version: EncodingVersion): this
Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
Parameters
- version: EncodingVersion
  The encoding version to use to marshal request parameters.
Returns this
A proxy with the specified encoding version.

Implementation of SessionPrx.ice_encodingVersion
Inherited from ObjectPrx.ice_encodingVersion

ice_endpoints

ice_endpoints(endpoints: Endpoint[]): this
Creates a proxy that is identical to this proxy, except for the endpoints.
Parameters
- endpoints: Endpoint[]
  The endpoints for the new proxy.
Returns this
A proxy with the new endpoints.

Implementation of SessionPrx.ice_endpoints
Inherited from ObjectPrx.ice_endpoints

ice_endpointSelection

ice_endpointSelection(type: EndpointSelectionType): this
Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
Parameters
- type: EndpointSelectionType
  The new endpoint selection policy.
Returns this
A proxy with the specified endpoint selection policy.

Implementation of SessionPrx.ice_endpointSelection
Inherited from ObjectPrx.ice_endpointSelection

ice_facet

ice_facet(facet: string): this
Creates a proxy that is identical to this proxy, except for the facet.
Parameters
- facet: string
  The facet for the new proxy.
Returns this
A proxy with the new facet.

Implementation of SessionPrx.ice_facet
Inherited from ObjectPrx.ice_facet

ice_fixed

ice_fixed(connection: Connection): this
Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
Parameters
- connection: Connection
  The fixed proxy connection.
Returns this
A fixed proxy bound to the given connection.

Implementation of SessionPrx.ice_fixed
Inherited from ObjectPrx.ice_fixed

ice_flushBatchRequests

ice_flushBatchRequests(): AsyncResult<void>
Flushes any pending batched requests for this proxy.

Returns AsyncResult<void>
An asynchronous result that is resolved when the pending batched requests for this proxy are flushed.

Implementation of SessionPrx.ice_flushBatchRequests
Inherited from ObjectPrx.ice_flushBatchRequests

ice_getAdapterId

ice_getAdapterId(): string
Gets the adapter ID for this proxy.

Returns string
The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

Implementation of SessionPrx.ice_getAdapterId
Inherited from ObjectPrx.ice_getAdapterId

ice_getCachedConnection

ice_getCachedConnection(): Connection
Gets the cached Connection for this proxy. If the proxy does not yet have an established connection, it does not attempt to create a connection.

Returns Connection
The cached connection for this proxy, or null if the proxy does not have an established connection.

Implementation of SessionPrx.ice_getCachedConnection
Inherited from ObjectPrx.ice_getCachedConnection

ice_getCommunicator

ice_getCommunicator(): Communicator
Gets the communicator that created this proxy.

Returns Communicator
The communicator that created this proxy.

Implementation of SessionPrx.ice_getCommunicator
Inherited from ObjectPrx.ice_getCommunicator

ice_getConnection

ice_getConnection(): AsyncResult<Connection>
Gets the connection ID of this proxy.

Returns AsyncResult<Connection>
An asynchronous result that resolves to the connection used by this proxy.

Remarks
You can call this function to establish a connection or associate the proxy with an existing connection.

Implementation of SessionPrx.ice_getConnection
Inherited from ObjectPrx.ice_getConnection

ice_getConnectionId

ice_getConnectionId(): string
Gets the connection ID of this proxy.

Returns string
The connection ID.

Implementation of SessionPrx.ice_getConnectionId
Inherited from ObjectPrx.ice_getConnectionId

ice_getContext

ice_getContext(): Map<string, string>
Gets the per-proxy context for this proxy.

Returns Map<string, string>
The per-proxy context.

Implementation of SessionPrx.ice_getContext
Inherited from ObjectPrx.ice_getContext

ice_getEncodingVersion

ice_getEncodingVersion(): EncodingVersion
Gets the encoding version used to marshal request parameters.

Returns EncodingVersion
The encoding version.

Implementation of SessionPrx.ice_getEncodingVersion
Inherited from ObjectPrx.ice_getEncodingVersion

ice_getEndpoints

ice_getEndpoints(): Endpoint[]
Gets the endpoints used by this proxy.

Returns Endpoint[]
The endpoints used by this proxy.

Implementation of SessionPrx.ice_getEndpoints
Inherited from ObjectPrx.ice_getEndpoints

ice_getEndpointSelection

ice_getEndpointSelection(): EndpointSelectionType
Gets the endpoint selection policy for this proxy (randomly or ordered).

Returns EndpointSelectionType
The endpoint selection policy.

Implementation of SessionPrx.ice_getEndpointSelection
Inherited from ObjectPrx.ice_getEndpointSelection

ice_getFacet

ice_getFacet(): string
Gets the facet for this proxy.

Returns string
The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

Implementation of SessionPrx.ice_getFacet
Inherited from ObjectPrx.ice_getFacet

ice_getIdentity

ice_getIdentity(): Identity
Gets the identity embedded in this proxy.

Returns Identity
The identity of the target object.

Implementation of SessionPrx.ice_getIdentity
Inherited from ObjectPrx.ice_getIdentity

ice_getInvocationTimeout

ice_getInvocationTimeout(): number
Gets the invocation timeout of this proxy.

Returns number
The invocation timeout value.

Implementation of SessionPrx.ice_getInvocationTimeout
Inherited from ObjectPrx.ice_getInvocationTimeout

ice_getLocator

ice_getLocator(): Ice.LocatorPrx
Gets the locator for this proxy.

Returns Ice.LocatorPrx
The locator for this proxy. If no locator is configured, the return value is null.

Implementation of SessionPrx.ice_getLocator
Inherited from ObjectPrx.ice_getLocator

ice_getLocatorCacheTimeout

ice_getLocatorCacheTimeout(): number
Gets the locator cache timeout of this proxy.

Returns number
The locator cache timeout value.

Implementation of SessionPrx.ice_getLocatorCacheTimeout
Inherited from ObjectPrx.ice_getLocatorCacheTimeout

ice_getRouter

ice_getRouter(): Ice.RouterPrx
Gets the router for this proxy.

Returns Ice.RouterPrx
The router for the proxy. If no router is configured for the proxy, the return value is null.

Implementation of SessionPrx.ice_getRouter
Inherited from ObjectPrx.ice_getRouter

ice_id

ice_id(context?: Map<string, string>): AsyncResult<string>
Gets the type ID of the most-derived Slice interface supported by this object.
Parameters
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<string>
An asynchronous result that resolves to the Slice type ID of the most-derived interface.

Implementation of SessionPrx.ice_id
Inherited from ObjectPrx.ice_id

ice_identity

ice_identity(id: Identity): this
Creates a proxy that is identical to this proxy, except for the identity.
Parameters
- id: Identity
  The identity for the new proxy.
Returns this
A proxy with the new identity.

Implementation of SessionPrx.ice_identity
Inherited from ObjectPrx.ice_identity

ice_ids

ice_ids(context?: Map<string, string>): AsyncResult<string[]>
Gets the Slice interfaces supported by this object as a list of Slice type IDs.
Parameters
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<string[]>
An asynchronous result that resolves to an array of the Slice type IDs of the interfaces supported by this object, in alphabetical order

Implementation of SessionPrx.ice_ids
Inherited from ObjectPrx.ice_ids

ice_invocationTimeout

ice_invocationTimeout(timeout: number): this
Creates a proxy that is identical to this proxy, except for the invocation timeout.
Parameters
- timeout: number
  The new invocation timeout (in milliseconds).
Returns this
A proxy with the new timeout.

Implementation of SessionPrx.ice_invocationTimeout
Inherited from ObjectPrx.ice_invocationTimeout

ice_isA

ice_isA(typeId: string, context?: Map<string, string>): AsyncResult<boolean>
Tests whether this object supports a specific Slice interface.
Parameters
- typeId: string
  The type ID of the Slice interface to test against.
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<boolean>
An asynchronous result that resolves to true if the target object implements the Slice interface specified by typeId or implements a derived interface, false otherwise.

Implementation of SessionPrx.ice_isA
Inherited from ObjectPrx.ice_isA

ice_isBatchOneway

ice_isBatchOneway(): boolean
Determines whether this proxy uses batch oneway invocations.

Returns boolean
true if this proxy uses batch oneway invocations, false otherwise.

Implementation of SessionPrx.ice_isBatchOneway
Inherited from ObjectPrx.ice_isBatchOneway

ice_isConnectionCached

ice_isConnectionCached(): boolean
Determines whether this proxy caches connections.

Returns boolean
true if this proxy caches connections, false otherwise.

Implementation of SessionPrx.ice_isConnectionCached
Inherited from ObjectPrx.ice_isConnectionCached

ice_isFixed

ice_isFixed(): boolean
Determines whether this proxy is a fixed proxy.

Returns boolean
true if this proxy is a fixed proxy, false otherwise.

Implementation of SessionPrx.ice_isFixed
Inherited from ObjectPrx.ice_isFixed

ice_isOneway

ice_isOneway(): boolean
Determines whether this proxy uses oneway invocations.

Returns boolean
true if this proxy uses oneway invocations, false otherwise.

Implementation of SessionPrx.ice_isOneway
Inherited from ObjectPrx.ice_isOneway

ice_isTwoway

ice_isTwoway(): boolean
Determines whether this proxy uses twoway invocations.

Returns boolean
true if this proxy uses twoway invocations, false otherwise.

Implementation of SessionPrx.ice_isTwoway
Inherited from ObjectPrx.ice_isTwoway

ice_locator

ice_locator(locator: Ice.LocatorPrx): this
Creates a proxy that is identical to this proxy, except for the locator.
Parameters
- locator: Ice.LocatorPrx
  The locator for the new proxy.
Returns this
A proxy with the specified locator.

Implementation of SessionPrx.ice_locator
Inherited from ObjectPrx.ice_locator

ice_locatorCacheTimeout

ice_locatorCacheTimeout(timeout: number): this
Creates a proxy that is identical to this proxy, except for the locator cache timeout.
Parameters
- timeout: number
  The new locator cache timeout (in seconds).
Returns this
A proxy with the new timeout.

Implementation of SessionPrx.ice_locatorCacheTimeout
Inherited from ObjectPrx.ice_locatorCacheTimeout

ice_oneway

ice_oneway(): this
Creates a proxy that is identical to this proxy, but uses oneway invocations.

Returns this
A proxy that uses oneway invocations.

Implementation of SessionPrx.ice_oneway
Inherited from ObjectPrx.ice_oneway

ice_ping

ice_ping(context?: Map<string, string>): AsyncResult<void>
Tests whether the target object of this proxy can be reached.
Parameters
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<void>
An asynchronous result that resolves when the ping operation completes.

Implementation of SessionPrx.ice_ping
Inherited from ObjectPrx.ice_ping

ice_router

ice_router(router: Ice.RouterPrx): this
Creates a proxy that is identical to this proxy, except for the router.
Parameters
- router: Ice.RouterPrx
  The router for the new proxy.
Returns this
A proxy with the specified router.

Implementation of SessionPrx.ice_router
Inherited from ObjectPrx.ice_router

ice_toString

ice_toString(): string
Creates a stringified version of this proxy.

Returns string
A stringified proxy.

Implementation of SessionPrx.ice_toString
Inherited from ObjectPrx.ice_toString

ice_twoway

ice_twoway(): this
Creates a proxy that is identical to this proxy, but uses twoway invocations.

Returns this
A proxy that uses twoway invocations.

Implementation of SessionPrx.ice_twoway
Inherited from ObjectPrx.ice_twoway

keepAlive

keepAlive(context?: Map<string, string>): AsyncResult<void>
Keeps the session alive.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Deprecated
As of Ice 3.8, there is no need to call this operation, and its implementation does nothing.

releaseObject

releaseObject(id: Identity, context?: Map<string, string>): AsyncResult<void>
Releases an object that was allocated using IceGrid.SessionPrx.allocateObjectById or IceGrid.SessionPrx.allocateObjectByType.
Parameters
- id: Identity
  The identity of the object to release.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.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.

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

setAllocationTimeout

setAllocationTimeout(
timeout: number,
context?: Map<string, string>,
): AsyncResult<void>
Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation of IceGrid.SessionPrx.allocateObjectById and IceGrid.SessionPrx.allocateObjectByType waits for the duration of this timeout.
Parameters
- timeout: number
  The timeout in milliseconds.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

`Static`checkedCast

checkedCast(
    prx: ObjectPrx,
    facet?: string,
    context?: Map<string, string>,
): AsyncResult<IceGrid.SessionPrx>
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
Parameters
- prx: ObjectPrx
  The source proxy.
- Optionalfacet: string
  An optional facet name.
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<IceGrid.SessionPrx>
A proxy with the requested type and facet, or null if the target object does not support the requested type.

Overrides ObjectPrx.checkedCast

`Static`ice_staticId

ice_staticId(): string
Returns the Slice type ID associated with this type.

Returns string
The Slice type ID.

Inherited from ObjectPrx.ice_staticId

`Static`uncheckedCast

uncheckedCast(prx: ObjectPrx, facet?: string): IceGrid.SessionPrx
Creates a new proxy from an existing proxy.
Parameters
- prx: ObjectPrx
  The source proxy.
- Optionalfacet: string
  An optional facet name.
Returns IceGrid.SessionPrx
A new proxy with the requested type and facet, or null if the source proxy is null.

Overrides ObjectPrx.uncheckedCast
uncheckedCast(prx: ObjectPrx, facet?: string): IceGrid.SessionPrx
Creates a new proxy from an existing proxy.
Parameters
- prx: ObjectPrx
  The source proxy.
- Optionalfacet: string
  An optional facet name.
Returns IceGrid.SessionPrx
A new proxy with the requested type and facet, or null if the source proxy is null.

Overrides ObjectPrx.uncheckedCast

Class SessionPrx

Remarks

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns IceGrid.SessionPrx

Throws

Methods

allocateObjectById

Parameters

Returns AsyncResult<ObjectPrx>

Throws

Throws

See

allocateObjectByType

Parameters

Returns AsyncResult<ObjectPrx>

Throws

See

destroy

Parameters

Returns AsyncResult<void>

equals

Parameters

Returns boolean

ice_adapterId

Parameters

Returns this

ice_batchOneway

Returns this

ice_connectionCached

Parameters

Returns this

ice_connectionId

Parameters

Returns this

ice_context

Parameters

Returns this

ice_encodingVersion

Parameters

Returns this

ice_endpoints

Parameters

Returns this

ice_endpointSelection

Parameters

Returns this

ice_facet

Parameters

Returns this

ice_fixed

Parameters

Returns this

ice_flushBatchRequests

Returns AsyncResult<void>

ice_getAdapterId

Returns string

ice_getCachedConnection

Returns Connection

ice_getCommunicator

Returns Communicator

ice_getConnection

Returns AsyncResult<Connection>

Remarks

ice_getConnectionId

Returns string

ice_getContext

Returns Map<string, string>

ice_getEncodingVersion

Returns EncodingVersion

ice_getEndpoints

Returns Endpoint[]

ice_getEndpointSelection

Returns EndpointSelectionType

`Static`checkedCast