Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [TCP] >  [Framed] >  [PassthroughOperation]
Private  Storage   

class EnsLib.TCP.Framed.PassthroughOperation extends Ens.BusinessOperation

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 2


Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.TCP.FramedOutboundAdapter.

RequestResponse
Ens.StreamContainer Ens.StreamContainer

Properties
%AlertStartTime %ConfigName %ConfigQueueName %LastActionTime
%LastHandledTime %LastReportedError %QuitTask %RequestHeader
%SessionId %SuperSession %WarnedLatest %isShadow
AckNotOK AckNotOKAsChars AckOK AckOKAsChars
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
ArchiveIO BusinessPartner DeferResponse FailureTimeout
IOLogEntry InactivityTimeout NoFailWhileDisconnected QueueCountAlert
QueueWaitAlert ReplyCodeActions Retry RetryCount
RetryInterval SendSuperSession SuspendMessage ThrottleDelay

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %SuperSessionSet %ValidateObject AdapterName
AssignOneSetting CloseIOLogEntry DeferResponse EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GenerateSuperSession GetDeferredResponseToken
GetMessageList GetProductionSettingValue GetProductionSettings GetPropertyConnections
GetSettings GetShadowInstance IncludeSuperSession NewIOLogEntry
OnError OnFailureTimeout OnGenerateSuperSession OnGetConnections
OnGetReplyAction OnInit OnKeepalive OnMessage
OnMonitor OnProductionStart OnProductionStop OnTearDown
QueueName SaveIOLogEntry SendAlert SendDeferredResponse
SendRequestAsync SendRequestSync


Parameters

• parameter ADAPTER = "EnsLib.TCP.FramedOutboundAdapter";
The type of adapter used to communicate with external systems
• parameter SETTINGS = "AckOK:Additional,AckNotOK:Additional";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property AckNotOK as %String [ InitialExpression = "21" ];
Comma separated list of control characters that indicate message not received OK This is compared to response if present Can be Decimal or Hex if have preceding 'x' For example 21 or x15
• property AckNotOKAsChars as %String [ Transient ];
Used to store actual Acknowledgement Not OK characters
• property AckOK as %String [ InitialExpression = "6" ];
Comma separated list of control characters that indicate message received OK. This is compared to response if present Can be Decimal or Hex if have preceding 'x' For example 6 or x06
• property AckOKAsChars as %String [ Transient ];
Used to store actual Acknowledgement OK characters

Methods

• method OnInit() as %Status
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
• method OnMessage(pRequest As Ens.StreamContainer, Output pResponse As Ens.StreamContainer) as %Status
This is the default message handler. All request types not declared in the message map are delivered here


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