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

EnsLib.TCP.Framed.PassthroughService

class EnsLib.TCP.Framed.PassthroughService extends Ens.BusinessService

Property Inventory

Method Inventory

Parameters

parameter ADAPTER = EnsLib.TCP.FramedInboundAdapter;
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,AckOK:Connection,AckNotOK:Connection,SyncCall:Connection,SyncCallTimeout:Connection;
Inherited description: 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 Can be Decimal or Hex if have preceding 'x' For example 21 or x15
Property methods: AckNotOKAsCharsDisplayToLogical(), AckNotOKAsCharsGet(), AckNotOKAsCharsIsValid(), AckNotOKAsCharsLogicalToDisplay(), AckNotOKAsCharsLogicalToOdbc(), AckNotOKAsCharsNormalize(), AckNotOKAsCharsSet(), AckNotOKDisplayToLogical(), AckNotOKGet(), AckNotOKIsValid(), AckNotOKLogicalToDisplay(), AckNotOKLogicalToOdbc(), AckNotOKNormalize(), AckNotOKSet()
property AckNotOKAsChars as %String [ Transient ];
Used to store actual Acknowledgement Not OK characters
Property methods: AckNotOKAsCharsDisplayToLogical(), AckNotOKAsCharsGet(), AckNotOKAsCharsIsValid(), AckNotOKAsCharsLogicalToDisplay(), AckNotOKAsCharsLogicalToOdbc(), AckNotOKAsCharsNormalize(), AckNotOKAsCharsSet()
property AckOK as %String [ InitialExpression = "6" ];
Comma separated list of control characters that indicate message received OK Can be Decimal or Hex if have preceding 'x' For example 6 or x06
Property methods: AckOKAsCharsDisplayToLogical(), AckOKAsCharsGet(), AckOKAsCharsIsValid(), AckOKAsCharsLogicalToDisplay(), AckOKAsCharsLogicalToOdbc(), AckOKAsCharsNormalize(), AckOKAsCharsSet(), AckOKDisplayToLogical(), AckOKGet(), AckOKIsValid(), AckOKLogicalToDisplay(), AckOKLogicalToOdbc(), AckOKNormalize(), AckOKSet()
property AckOKAsChars as %String [ Transient ];
Used to store actual Acknowledgement OK characters
Property methods: AckOKAsCharsDisplayToLogical(), AckOKAsCharsGet(), AckOKAsCharsIsValid(), AckOKAsCharsLogicalToDisplay(), AckOKAsCharsLogicalToOdbc(), AckOKAsCharsNormalize(), AckOKAsCharsSet()
property SendAcknowledgement as %Boolean [ InitialExpression = 1 ];
Send AckOK/ActNotOK characters
Property methods: SendAcknowledgementDisplayToLogical(), SendAcknowledgementGet(), SendAcknowledgementIsValid(), SendAcknowledgementLogicalToDisplay(), SendAcknowledgementNormalize(), SendAcknowledgementSet()
property SyncCall as %Boolean [ InitialExpression = 0 ];
Send the inbound message stream to the target Synchronously. The default is Asynchronously and any Acknowledgement is controlled by the SendAcknowledgement setting. If the message is sent synchronously then the response from the target called is used as the Acknowledgement if it is a stream. If it is not a stream then the SendAcknowledgement settings are used and the ACK not OK character(s) are sent. If there are more than one synchronous targets then the last response is used as the Acknowledgement.
Property methods: SyncCallDisplayToLogical(), SyncCallGet(), SyncCallIsValid(), SyncCallLogicalToDisplay(), SyncCallNormalize(), SyncCallSet(), SyncCallTimeoutDisplayToLogical(), SyncCallTimeoutGet(), SyncCallTimeoutIsValid(), SyncCallTimeoutLogicalToDisplay(), SyncCallTimeoutNormalize(), SyncCallTimeoutSet()
property SyncCallTimeout as %Integer [ InitialExpression = -1 ];
If the message is passed to the target as SyncCall then this is the timeout to wait for a response from the target. The default is unlimited timeout.
Property methods: SyncCallTimeoutDisplayToLogical(), SyncCallTimeoutGet(), SyncCallTimeoutIsValid(), SyncCallTimeoutLogicalToDisplay(), SyncCallTimeoutNormalize(), SyncCallTimeoutSet()
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()

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 OnInit() as %Status
This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnProcessInput(pInput As %Stream.Object, pOutput As %Stream.Object, 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

Subclasses