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

EnsLib.TCP.FramedOutboundAdapter

class EnsLib.TCP.FramedOutboundAdapter extends EnsLib.TCP.OutboundAdapter, EnsLib.TCP.TextLineCommon, EnsLib.TCP.FramedCommon

Adapter that sends out a Framed block of bytes over a TCP connection and receives a response block

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = FlushBeforeSend:Connection,UseFileStream,MessageFrameStart:Additional,MessageFrameEnd:Additional,ReplyHasSameFraming:Additional,RemoveFraming:Additional,DiscardDataNotwithinFraming:Additional,ReplyMessageLength:Additional;
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 FlushBeforeSend as %Boolean [ InitialExpression = 1 ];
Read out any data in the input buffer before sending output. This ensures that any reply received corresponds to the sent message, and if not looking for replies that the input buffer does not fill up with unexpected junk.
Property methods: FlushBeforeSendDisplayToLogical(), FlushBeforeSendGet(), FlushBeforeSendIsValid(), FlushBeforeSendLogicalToDisplay(), FlushBeforeSendNormalize(), FlushBeforeSendSet()
property ReplyHasSameFraming as %Boolean [ InitialExpression = 1 ];
Reply message has same framing as outbound If this is true it takes precedence over ReplyMessageLength
Property methods: ReplyHasSameFramingDisplayToLogical(), ReplyHasSameFramingGet(), ReplyHasSameFramingIsValid(), ReplyHasSameFramingLogicalToDisplay(), ReplyHasSameFramingNormalize(), ReplyHasSameFramingSet()
property ReplyMessageLength as %Integer [ InitialExpression = 1 ];
Length of reply message to receive if fixed length If ReplyHasSameFraming is true then that takes precedence.
Property methods: ReplyMessageLengthDisplayToLogical(), ReplyMessageLengthGet(), ReplyMessageLengthIsValid(), ReplyMessageLengthLogicalToDisplay(), ReplyMessageLengthNormalize(), ReplyMessageLengthSet()

Methods

method OnInit() as %Status [ Language = objectscript ]
Inherited description: This user callback method is called just after %OnNew()
method SendMessageStream(pRequestStream As %Stream.Object, ByRef pResponseStream As %CharacterStream = "%GlobalCharacterStream") as %Status [ Language = objectscript ]
method SendMessageString(pRequestString As %String, Output pResponseString As %String) as %Status [ Language = objectscript ]

Inherited Methods