This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsLib.TCP.PassthroughService


class EnsLib.TCP.PassthroughService extends Ens.BusinessService

Property Inventory

Method Inventory


parameter ADAPTER = EnsLib.TCP.CountedInboundAdapter;
Inherited description: 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;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property %HeaderFilename as %String;
Toggle string for 2-block protocol: name block, then stream content block
Property methods: %HeaderFilenameDisplayToLogical(), %HeaderFilenameGet(), %HeaderFilenameIsValid(), %HeaderFilenameLogicalToDisplay(), %HeaderFilenameLogicalToOdbc(), %HeaderFilenameNormalize(), %HeaderFilenameSet()
property GetStreamName as %Boolean [ InitialExpression = 1 ];
Should we expect to receive a stream name text string prefix before each stream we receive?
Property methods: GetStreamNameDisplayToLogical(), GetStreamNameGet(), GetStreamNameIsValid(), GetStreamNameLogicalToDisplay(), GetStreamNameNormalize(), GetStreamNameSet()
property SendAcknowledgement as %Boolean [ InitialExpression = 1 ];
Should we let the client know that we got the message?
Property methods: SendAcknowledgementDisplayToLogical(), SendAcknowledgementGet(), SendAcknowledgementIsValid(), SendAcknowledgementLogicalToDisplay(), SendAcknowledgementNormalize(), SendAcknowledgementSet()
property TargetConfigNames as %String (MAXLEN = 1000);
Configuration item(s) to which to send file stream messages
Property methods: TargetConfigNamesDisplayToLogical(), TargetConfigNamesGet(), TargetConfigNamesIsValid(), TargetConfigNamesLogicalToDisplay(), TargetConfigNamesLogicalToOdbc(), TargetConfigNamesNormalize(), TargetConfigNamesSet()


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 %Library.RegisteredObject, ByRef pHint As %Library.String) 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

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new window