IceGrid

Interface _SessionOperationsNC

All Superinterfaces:

Glacier2._SessionOperationsNC

All Known Subinterfaces:

Session

public interface _SessionOperationsNC
extends Glacier2._SessionOperationsNC

A session object is used by IceGrid clients to allocate and release objects. Client sessions are either created with the Registry object or the registry client SessionManager object.

See Also:

Registry, SessionManager

Method Summary

Modifier and Type	Method and Description
void	allocateObjectById_async(AMD_Session_allocateObjectById __cb, Ice.Identity id) Allocate an object.
void	allocateObjectByType_async(AMD_Session_allocateObjectByType __cb, java.lang.String type) Allocate an object with the given type.
void	keepAlive() Keep the session alive.
void	releaseObject(Ice.Identity id) Release an object that was allocated using allocateObjectById or allocateObjectByType.
void	setAllocationTimeout(int timeout) Set the allocation timeout.

Methods inherited from interface Glacier2._SessionOperationsNC

destroy

Method Detail

keepAlive

void keepAlive()

Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.

See Also:

_RegistryOperations.getSessionTimeout(Ice.Current)

allocateObjectById_async

void allocateObjectById_async(AMD_Session_allocateObjectById __cb,
                              Ice.Identity id)
                       throws AllocationException,
                              ObjectNotRegisteredException

Allocate an object. Depending on the allocation timeout, this operation might hang until the object is available or until the timeout is reached.

Parameters:

__cb - The callback object for the operation.

id - The identity of the object to allocate.

Throws:

ObjectNotRegisteredException - Raised if the object with the given identity is not registered with the registry.

AllocationException - Raised if the object can't be allocated.

allocateObjectByType_async

void allocateObjectByType_async(AMD_Session_allocateObjectByType __cb,
                                java.lang.String type)
                         throws AllocationException

Allocate an object with the given type. Depending on the allocation timeout, this operation can block until an object becomes available or until the timeout is reached.

Parameters:

__cb - The callback object for the operation.

type - The type of the object.

Throws:

AllocationException - Raised if the object could not be allocated.

releaseObject

void releaseObject(Ice.Identity id)
            throws AllocationException,
                   ObjectNotRegisteredException

Release an object that was allocated using allocateObjectById or allocateObjectByType.

Parameters:

id - The identity of the object to release.

Throws:

ObjectNotRegisteredException - Raised if the object with the given identity is not registered with the registry.

AllocationException - Raised if the given object can't be released. This might happen if the object isn't allocatable or isn't allocated by the session.

setAllocationTimeout

void setAllocationTimeout(int timeout)

Set the allocation timeout. If no objects are available for an allocation request, a call to allocateObjectById or allocateObjectByType will block for the duration of this timeout.

Parameters:

timeout - The timeout in milliseconds.