IceGrid

Class _SessionDisp

java.lang.Object

Ice.ObjectImpl

IceGrid._SessionDisp

All Implemented Interfaces:

Glacier2._SessionOperations, Glacier2._SessionOperationsNC, Glacier2.Session, Ice.Object, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

_SessionTie

public abstract class _SessionDisp
extends Ice.ObjectImpl
implements Session

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, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface IceGrid.Session

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_SessionDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___allocateObjectById(Session __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___allocateObjectByType(Session __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___keepAlive(Session __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___releaseObject(Session __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setAllocationTimeout(Session __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
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	destroy() Destroy the session.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
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 class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IceGrid._SessionOperations

allocateObjectById_async, allocateObjectByType_async, keepAlive, releaseObject, setAllocationTimeout

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from interface Glacier2._SessionOperations

destroy

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_SessionDisp

public _SessionDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

destroy

public final void destroy()

Destroy the session. This is called automatically when the router is destroyed.

Specified by:

destroy in interface Glacier2._SessionOperationsNC

allocateObjectById_async

public final 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

public final 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.

keepAlive

public final 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)

releaseObject

public final 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

public final 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.

___keepAlive

public static Ice.DispatchStatus ___keepAlive(Session __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___allocateObjectById

public static Ice.DispatchStatus ___allocateObjectById(Session __obj,
                                                       IceInternal.Incoming __inS,
                                                       Ice.Current __current)

___allocateObjectByType

public static Ice.DispatchStatus ___allocateObjectByType(Session __obj,
                                                         IceInternal.Incoming __inS,
                                                         Ice.Current __current)

___releaseObject

public static Ice.DispatchStatus ___releaseObject(Session __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___setAllocationTimeout

public static Ice.DispatchStatus ___setAllocationTimeout(Session __obj,
                                                         IceInternal.Incoming __inS,
                                                         Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl