This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

EnsLib.PrivateSession.Duplex

abstract class EnsLib.PrivateSession.Duplex extends Ens.BusinessDuplex

Property Inventory

Method Inventory

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 methods: DeferredResponseTokenDisplayToLogical(), DeferredResponseTokenGet(), DeferredResponseTokenIsValid(), DeferredResponseTokenLogicalToDisplay(), DeferredResponseTokenLogicalToOdbc(), DeferredResponseTokenNormalize(), DeferredResponseTokenSet()
property DuplexTargetConfigName as %String (MAXLEN = 1000);
Configuration item(s) to which to send messages
Property methods: DuplexTargetConfigNameDisplayToLogical(), DuplexTargetConfigNameGet(), DuplexTargetConfigNameIsValid(), DuplexTargetConfigNameLogicalToDisplay(), DuplexTargetConfigNameLogicalToOdbc(), DuplexTargetConfigNameNormalize(), DuplexTargetConfigNameSet()
property ReceivedDataQueue as list of %Library.Persistent;
This holds data that is not yet ready for processing
Property methods: ReceivedDataQueueBuildValueArray(), ReceivedDataQueueCollectionToDisplay(), ReceivedDataQueueCollectionToOdbc(), ReceivedDataQueueDisplayToCollection(), ReceivedDataQueueGet(), ReceivedDataQueueGetObject(), ReceivedDataQueueGetObjectId(), ReceivedDataQueueGetSwizzled(), ReceivedDataQueueIsValid(), ReceivedDataQueueOdbcToCollection(), ReceivedDataQueueSet(), ReceivedDataQueueSetObject(), ReceivedDataQueueSetObjectId()

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
Inherited description: 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

Inherited Members

Inherited Properties

Inherited Methods

Feedback