Skip to main content

%DeepSee.Session

Class %DeepSee.Session Extends %RegisteredObject [ System = 3 ]

This class provides the API for DeepSee sessions. An instance of this class represents the current session.

Properties​

sessionId​

Property sessionId As %String;

Id for this session.

Methods​

%CreateSession​

ClassMethod %CreateSession(pSessionId As %String = "", Output pSC As %Status) As Session

Create a new DeepSee session. If pSessionId is provided, then it used, otherwise $J is used.

%EndSession​

Method %EndSession() As %Status

Terminate this DeepSee session and remove all definitions associated with it.

%ResumeSession​

ClassMethod %ResumeSession(pSessionId As %String = "", Output pSC As %Status) As Session

Resume a previously running session.

%SuspendSession​

Method %SuspendSession() As %Status

Suspend the currently running session.

%GetSessionId​

Method %GetSessionId() As %Status

Get the session ID for this session.

%OnNew​

Method %OnNew() As %Status [ Private, ProcedureBlock = 1, ServerOnly = 1 ]

%OnClose​

Method %OnClose() As %Status [ Private, ProcedureBlock = 1, ServerOnly = 1 ]

%GetTrackingKeys​

ClassMethod %GetTrackingKeys() As %Status [ Internal ]

If this process does not already have a collection of shared memory keys stored in %dsTrackingKeys, create them.