Class Reference
Cache for UNIX 2018.1
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

class EnsLib.TCP.PassthroughService extends Ens.BusinessService

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 4 3


Summary

This is an Ensemble Business Service class.

The associated Adapter class is EnsLib.TCP.CountedInboundAdapter.

Properties
%AlertStartTime %ConfigName %ConfigQueueName
%HeaderFilename %LastActionTime %LastHandledTime
%LastReportedError %OutsideCreated %PreserveSession
%ProcessInputCalled %QuitTask %RequestHeader
%SessionId %SuperSession %SuperSessionCreatedBeforeSession
%WaitForNextCallInterval %WarnedLatest %isShadow
Adapter AlertGracePeriod AlertGroups
AlertOnError ArchiveIO BusinessPartner
GenerateSuperSessionID GetStreamName IOLogEntry
InactivityTimeout SendAcknowledgement TargetConfigNames
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 EnumerateSettingsClose EnumerateSettingsExecute
EnumerateSettingsFetch ForceSessionId GenerateSuperSession GetDeferredResponseToken
GetProductionSettingValue GetProductionSettings GetPropertyConnections GetSettings
GetShadowInstance NewIOLogEntry OnError OnGenerateSuperSession
OnGetConnections OnInit OnKeepalive OnMonitor
OnProcessInput OnProductionStart OnProductionStop OnTearDown
PopulateSuperSession QueueName SaveIOLogEntry SendAlert
SendDeferredResponse SendRequestAsync SendRequestSync resolveAndIndex

Subclasses
EnsLib.XML.TCPService

Parameters

• parameter ADAPTER = "EnsLib.TCP.CountedInboundAdapter";
The type of adapter used to communicate with external systems
• parameter CONTAINERCLASS = "Ens.StreamContainer";
• parameter SETTINGS = "TargetConfigNames:Basic:selector?multiSelect=1&context={Ens.ContextSearch/ProductionItems?targets=1&productionName=@productionId},SendAcknowledgement:Connection,GetStreamName:Connection";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property %HeaderFilename as %String;
Toggle string for 2-block protocol: name block, then stream content block
• property GetStreamName as %Boolean [ InitialExpression = 1 ];
Should we expect to receive a stream name text string prefix before each stream we receive?
• property SendAcknowledgement as %Boolean [ InitialExpression = 1 ];
Should we let the client know that we got the message?
• property TargetConfigNames as %String(MAXLEN=1000);
Configuration item(s) to which to send file stream messages

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 OnProcessInput(pInput As %Stream.Object, pOutput As %RegisteredObject) as %Status
Wrap the input stream object in a StreamContainer message object and send it. If the SyncCall setting is true, send synchronously; otherwise send async to ensure that we don't return to the Adapter and let it delete the stream before the target Config Item is finished processing it.
• method resolveAndIndex(pDoc As %Persistent) as %Status
Initialize and perform requested validation if any


Copyright © 1997-2018 InterSystems Corporation, Cambridge, MA