EnsLib.TCP.FramedInboundAdapter
class EnsLib.TCP.FramedInboundAdapter extends EnsLib.TCP.InboundAdapter, EnsLib.TCP.FramedCommon, EnsLib.TCP.TextLineCommon
Inbound adapter for framed data over TCPProperty Inventory (Including Private)
Method Inventory (Including Private)
Parameters
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
Properties (Including Private)
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()
Methods (Including Private)
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 (Including Private)
- %CredentialsObj
- %HadCR
- %PartialLine
- %PoolLimit
- %Table
- %WarnedLatest
- %logConnections
- %outIPAddr
- AllowedIPAddresses
- BusinessHost
- CallInterval
- Charset
- Connected
- Credentials
- Device
- DiscardDataNotwithinFraming
- IOAddr
- JobPerConnection
- KeepaliveInterval
- LocalInterface
- MessageFrameEnd
- MessageFrameEndAsChars
- MessageFrameStart
- MessageFrameStartAsChars
- OldIO
- Port
- QSize
- ReadTimeout
- RegistryID
- RemoveFraming
- SSLConfig
- Socket
- StayConnected
- Terminators
- UseFileStream
Inherited Methods (Including Private)
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnClose()
- %OnConstructClone()
- %OnNew()
- %OnValidateObject()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AsciiOrHexAsChars()
- AssignOneSetting()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- ConnectOut()
- ConnectedSet()
- CredentialsSet()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- FlushWrite()
- GetAddress()
- GetDynamicSettingRow()
- GetSettingRow()
- GetSettings()
- IsReadError()
- IsWriteError()
- OnKeepalive()
- OnTask()
- OnTearDown()
- ReadFixedLengthStream()
- ReadFramedStream()
- ReadFramedString()
- ReadLine()
- TestConnection()
- Write()
- WriteFramedStream()
- WriteFramedString()
- WriteLine()
- connectedJob()