Class EnsLib.TCP.FramedInboundAdapter

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

Inbound adapter for framed data over TCP

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	2	3

Summary

Properties
%CredentialsObj	%HadCR	%PartialLine	%PoolLimit
%Table	%WarnedLatest	%logConnections	%outIPAddr
AddFramingToAcknowledgement	AllowedIPAddresses	BusinessHost	CallInterval
Charset	Connected	Credentials	Device
DiscardDataNotwithinFraming	DiscardSilently	IOAddr	JobPerConnection
KeepaliveInterval	LocalInterface	MessageFrameEnd	MessageFrameEndAsChars
MessageFrameStart	MessageFrameStartAsChars	OldIO	Port
QSize	ReadTimeout	RegistryID	RemoveFraming
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	ConnectOut	ConnectedSet	CredentialsSet
Disconnect	EnumerateSettingsClose	EnumerateSettingsExecute	EnumerateSettingsFetch
FlushWrite	GetAddress	GetSettings	IsReadError
IsWriteError	OnConnected	OnInit	OnKeepalive
OnTask	OnTearDown	ReadFixedLengthStream	ReadFramedStream
ReadFramedString	ReadLine	TestConnection	Write
WriteFramedStream	WriteFramedString	WriteLine	connectedJob

Parameters

• parameter SERVICEINPUTCLASS = "Ens.StreamContainer";

• parameter SERVICEOUTPUTCLASS = "Ens.StreamContainer";

• parameter SETTINGS = "UseFileStream,MessageFrameStart:Additional,MessageFrameEnd:Additional,RemoveFraming:Additional,DiscardDataNotwithinFraming:Additional,DiscardSilently:Additional,AddFramingToAcknowledgement:Additional";

List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• 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 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.

Methods

• method Disconnect()

• method OnConnected() as %Status

• method OnInit() as %Status

This user callback method is called just after %OnNew()

Class Reference IRIS for UNIX 2024.1.2
Documentation Search