Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsLib.TCP.FramedOutboundAdapter
Private  Storage   

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

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 3


Summary


Properties
%CredentialsObj %HadCR %PartialLine %Table
%WarnedLatest %lastRetryReconnect %logConnections BusinessHost
Charset ConnectTimeout Connected Credentials
Device DiscardDataNotwithinFraming FlushBeforeSend GetReply
IOAddr IPAddress KeepaliveInterval LocalInterface
MessageFrameEnd MessageFrameEndAsChars MessageFrameStart MessageFrameStartAsChars
OldIO Port ReadTimeout ReconnectRetry
RegistryID RemoveFraming ReplyHasSameFraming ReplyMessageLength
ResponseTimeout SSLConfig Socket StayConnected
Terminators UseFileStream

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AsciiOrHexAsChars AssignOneSetting ClearAllAppData ClearRuntimeAppData
ClearStaticAppData Connect ConnectedSet CredentialsSet
Disconnect EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch
FlushWrite GetAddress GetSettings IsReadError
IsWriteError OnInit OnKeepalive OnTearDown
ReadFixedLengthStream ReadFramedStream ReadFramedString ReadLine
SendMessageStream SendMessageString TestConnection Write
WriteFramedStream WriteFramedString WriteLine


Parameters


• parameter SETTINGS = "FlushBeforeSend:Connection,UseFileStream,MessageFrameStart:Additional,MessageFrameEnd:Additional,ReplyHasSameFraming:Additional,RemoveFraming:Additional,DiscardDataNotwithinFraming:Additional,ReplyMessageLength:Additional";
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 ReplyHasSameFraming as %Boolean [ InitialExpression = 1 ];
Reply message has same framing as outbound If this is true it takes precedence over ReplyMessageLength
• property ReplyMessageLength as %Integer [ InitialExpression = 1 ];
Length of reply message to receive if fixed length If ReplyHasSameFraming is true then that takes precedence.

Methods


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