Table of Contents

OIL2 Class Standard.AllocateSessionID


class Standard . AllocateSessionID {
        assoc   activeSessions;
        int32   requestCount;
        oid     serviceOID;
} inherits from Object;

DESCRIPTION

The AllocateSessionID class is intended to be used by the HTTPcreateApplicationSession.

METHODS


Standard.AllocateSessionID:registerSession

AllocateSessionID:registerSession(string sessionID, oid sessionObj)

Method Description

Once initialized, an application session should send a registerSession message to note that the session has successfully become active. When the application session terminates, it must send a noteSessionTerminated message.

Return Value

Returns 0.


Standard.AllocateSessionID:lookupSession

AllocateSessionID:lookupSession(string sessionID)

Method Description


Standard.AllocateSessionID:noteSessionTerminated

AllocateSessionID:noteSessionTerminated(string sessionID)

Method Description

Application sessions register their existence with the registerSession method. This method provides the inverse functionality. A terminated application session must send a noteSessionTerminated message to enable the both the potential reuse of the sessionID and, more importantly, the recovery of the storage associated with remembering the existence of the user's session.

Return Value

Returns 0.


Standard.AllocateSessionID:makeSessionID

AllocateSessionID:makeSessionID(optional int32 reserveID)

Method Description

A unique, randomly-generated session ID is allocated by the makeSessionID method. Normally, this method is automatically called by getRequest; however, it can be used in a standalone fashion by application which need to allocate a unique section of the web site's naming tree and want to ensure there are no conflicts with any other application.

If the optional Boolean argument reserveID is set to 1, the session ID is reserved to prevent any possible duplicate allocation between the invocations of makeSessionID and reserveSession.

Return Value

A string of hexadecimal characters is always returned.


Generated: Wed, 14 Mar 2012 02:52:23 EDT
Support Information