Module com.zeroc.icegrid

Package com.zeroc.IceGrid

Interface AsyncSession

All Superinterfaces:

AsyncSession, Object

public interface AsyncSession
extends AsyncSession

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

Remarks: The Slice compiler generated this skeleton interface from Slice interface ::IceGrid::Session.

Nested Class Summary

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
CompletionStage<ObjectPrx>	allocateObjectByIdAsync(Identity id, Current current)	Allocates an object.
CompletionStage<ObjectPrx>	allocateObjectByTypeAsync(String type, Current current)	Allocates an object with the given type.
default CompletionStage<OutgoingResponse>	dispatch(IncomingRequest request)	Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
CompletionStage<Void>	keepAliveAsync(Current current)	Keeps the session alive.
CompletionStage<Void>	releaseObjectAsync(Identity id, Current current)	Releases an object that was allocated using SessionPrx.allocateObjectById(com.zeroc.Ice.Identity) or SessionPrx.allocateObjectByType(java.lang.String).
CompletionStage<Void>	setAllocationTimeoutAsync(int timeout, Current current)	Sets the allocation timeout.

Methods inherited from interface com.zeroc.Glacier2.AsyncSession

destroyAsync

Methods inherited from interface com.zeroc.Ice.Object

ice_id, ice_ids, ice_isA, ice_ping

Method Details

keepAliveAsync

CompletionStage<Void> keepAliveAsync(Current current)

Keeps the session alive.

Parameters:

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

allocateObjectByIdAsync

CompletionStage<ObjectPrx> allocateObjectByIdAsync(Identity id,
 Current current)
                                            throws ObjectNotRegisteredException,
AllocationException

Allocates an object.

Parameters:

id - The identity of the object to allocate.

current - the Current object of the incoming request

Returns:

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

Throws:

AllocationException - Thrown when the allocation fails.

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

See Also:

• SessionPrx.setAllocationTimeout(int)
• SessionPrx.releaseObject(com.zeroc.Ice.Identity)

allocateObjectByTypeAsync

CompletionStage<ObjectPrx> allocateObjectByTypeAsync(String type,
 Current current)
                                              throws AllocationException

Allocates an object with the given type.

Parameters:

type - The type of the object.

current - the Current object of the incoming request

Returns:

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

Throws:

AllocationException - Thrown when the allocation fails.

See Also:

• SessionPrx.setAllocationTimeout(int)
• SessionPrx.releaseObject(com.zeroc.Ice.Identity)

releaseObjectAsync

CompletionStage<Void> releaseObjectAsync(Identity id,
 Current current)
                                  throws ObjectNotRegisteredException,
AllocationException

Releases an object that was allocated using SessionPrx.allocateObjectById(com.zeroc.Ice.Identity) or SessionPrx.allocateObjectByType(java.lang.String).

Parameters:

id - The identity of the object to release.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

Throws:

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.

setAllocationTimeoutAsync

CompletionStage<Void> setAllocationTimeoutAsync(int timeout,
 Current current)

Sets the allocation timeout. When no object is immediately available for an allocation request, the implementation of SessionPrx.allocateObjectById(com.zeroc.Ice.Identity) and SessionPrx.allocateObjectByType(java.lang.String) waits for the duration of this timeout.

Parameters:

timeout - The timeout in milliseconds.

current - the Current object of the incoming request

Returns:

a completion stage that the servant will complete when the invocation completes

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::IceGrid::Session"

dispatch

default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request)
                                            throws UserException

Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.

Specified by:

dispatch in interface AsyncSession

Specified by:

dispatch in interface Object

Parameters:

request - the incoming request

Returns:

the outgoing response

Throws:

UserException - if a UserException is thrown, Ice will marshal it as the response payload.