Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [PrivateSession] >  [Duplex]
Private  Storage   

abstract class EnsLib.PrivateSession.Duplex extends Ens.BusinessDuplex

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 3 11


Summary

This is a Business Service class.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%InPrivateSession %LastActionTime %LastHandledTime
%LastReportedError %OutsideCreated %PreserveSession
%PrivateSessionId %ProcessInputCalled %QuitTask
%RequestHeader %SessionId %SuperSession
%SuperSessionCreatedBeforeSession %WaitForNextCallInterval %WarnedLatest
%isShadow Adapter AlertGracePeriod
AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO BusinessPartner DeferResponse
DeferredResponseToken DuplexTargetConfigName EventDevice
FailureTimeout GenerateSuperSessionID IOLogEntry
InactivityTimeout NoFailWhileDisconnected QueueCountAlert
QueueWaitAlert ReceivedDataQueue ReplyCodeActions
Retry RetryCount RetryInterval
SendSuperSession SuspendMessage ThrottleDelay

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %InPrivateSessionGet %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnClose
%OnNew %OriginalNamespace %PackageName %RemoveFromSaveSet
%SerializeObject %SetModified %SuperSessionSet %ValidateObject
AdapterName AssignOneSetting CloseIOLogEntry DeferResponse
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch ForceSessionId
GenerateSuperSession GetDeferredResponseToken GetMessageList GetMsgHdrRequestKey
GetProductionSettingValue GetProductionSettings GetPropertyConnections GetSettings
GetShadowInstance IncludeSuperSession NewIOLogEntry OnBusinessType
OnError OnFailureTimeout OnGenerateSuperSession OnGetConnections
OnGetReplyAction OnInit OnKeepalive OnMessage
OnMonitor OnMsgPrivateSessionPoll OnMsgPrivateSessionStart OnMsgPrivateSessionStop
OnPrivateSessionStarted OnPrivateSessionStopped OnProcessInput OnProductionStart
OnProductionStop OnTask OnTearDown PopulateSuperSession
QueueName RegisterPrivateSession SaveIOLogEntry SendAlert
SendDeferredResponse SendDocumentToProcess SendRequestAsync SendRequestSync
SetEventDevice SetTimer StartPrivateSession StopPrivateSession
UnRegisterPrivateSession


Parameters

• parameter DOMAIN = "EnsDICOM";
Domain for error messages
• parameter SETTINGS = "DuplexTargetConfigName";
This holds the settings list

Properties

• property DeferredResponseToken as %String;
This holds the deferred response token
• property DuplexTargetConfigName as %String(MAXLEN=1000);
Configuration item(s) to which to send messages
• property ReceivedDataQueue as list of %Library.Persistent;
This holds data that is not yet ready for processing

Methods

• classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item)
Return an array of connections for drawing lines on the config diagram
• method OnMsgPrivateSessionPoll(pPollIn As EnsLib.PrivateSession.Message.Poll, Output pResponse As %Library.Persistent) as %Status
• method OnMsgPrivateSessionStart(pRequest As EnsLib.PrivateSession.Message.Start, Output pResponse As %Library.Persistent) as %Status
• method OnMsgPrivateSessionStop(pRequest As EnsLib.PrivateSession.Message.Stop, Output pResponse As %Library.Persistent) as %Status
• method OnPrivateSessionStarted(pSelfGenerated As %Boolean) as %Status
• method OnPrivateSessionStopped(pSelfGenerated As %Boolean, pAttachedMessage As %Persistent = "") as %Status
• method OnProcessInput(pInput As %Persistent, Output pOutput As %Persistent, ByRef pHint As %String) as %Status
This method is called by the TCP Adapter when a message is received.
• method OnTearDown() as %Status
This user callback method is called from %OnClose()
• method SendDocumentToProcess(pDocument As %Library.Persistent) as %Status
• method StartPrivateSession() as %Status
• method StopPrivateSession(pAttachedMessage As %Persistent = "") as %Status


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.