Skip to main content


class EnsLib.TCP.FramedInboundAdapter extends EnsLib.TCP.InboundAdapter, EnsLib.TCP.FramedCommon, EnsLib.TCP.TextLineCommon

Inbound adapter for framed data over TCP

Property Inventory

Method Inventory


parameter SERVICEINPUTCLASS = Ens.StreamContainer;
parameter SERVICEOUTPUTCLASS = Ens.StreamContainer;
parameter SETTINGS = UseFileStream,MessageFrameStart:Additional,MessageFrameEnd:Additional,RemoveFraming:Additional,DiscardDataNotwithinFraming:Additional,DiscardSilently:Additional,AddFramingToAcknowledgement:Additional;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property AddFramingToAcknowledgement as %Boolean [ InitialExpression = 1 ];
This setting is used to wrap the acknowledgement in the framing specified by MessageFrameStart & MessageFrameEnd. The default is true.
Property methods: AddFramingToAcknowledgementDisplayToLogical(), AddFramingToAcknowledgementGet(), AddFramingToAcknowledgementIsValid(), AddFramingToAcknowledgementLogicalToDisplay(), AddFramingToAcknowledgementNormalize(), AddFramingToAcknowledgementSet()
property DiscardSilently as %Boolean [ InitialExpression = 0 ];
If Discarding badly framed data and SendAcknowledgement is true and Acknowledgement not generated by target of the service then if this setting is false (the default) then return NACK else ignore.
Property methods: DiscardSilentlyDisplayToLogical(), DiscardSilentlyGet(), DiscardSilentlyIsValid(), DiscardSilentlyLogicalToDisplay(), DiscardSilentlyNormalize(), DiscardSilentlySet()


method Disconnect()
method OnConnected() as %Status
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab