Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / Ens.Enterprise.MsgBank.BankTCPAdapter
Private  Storage   

Ens.Enterprise.MsgBank.BankTCPAdapter


class Ens.Enterprise.MsgBank.BankTCPAdapter extends
EnsLib.TCP.InboundAdapter, EnsLib.TCP.CountedCommon

Block-oriented TCP Inbound Adapter used by the MsgBank to receive messages submitted by a MsgBank client node

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 2 1


Summary


Properties
%CredentialsObj %PoolLimit %WarnedLatest %logConnections
%outIPAddr AllowedIPAddresses BusinessHost CallInterval
Charset Connected Credentials Device
Endian IOAddr JobPerConnection KeepaliveInterval
LocalInterface OldIO Port QSize
ReadTimeout RegistryID 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
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
ConnectOut ConnectedSet CredentialsSet Disconnect
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch FlushWrite
GetAddress GetSettings IsReadError IsWriteError
OnConnected OnInit OnKeepalive OnTask
OnTearDown ReadCountedStream ReadCountedString TestConnection
WriteCountedStream WriteCountedString connectedJob


Parameters


• parameter SERVICEINPUTCLASS = "%Stream.Object";
• parameter SERVICEOUTPUTCLASS = "%String";
• parameter SETTINGS = "-Endian,-Charset";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property Charset as %String [ InitialExpression = "@UTF8" ];
Character encoding scheme used for decoding incoming data and encoding outgoing data. For no encoding, use 'Binary'. Other choices include:
Native - the default character encoding of the installed locale of the InterSystems IRIS server
latin1 - the ISO Latin1 8-bit encoding
ISO-8859-1 - the ISO Latin1 8-bit encoding
UTF-8 - the Unicode 8-bit encoding
Unicode - the Unicode 16-bit encoding (Little-Endian)
UnicodeBig - the Unicode 16-bit encoding (Big-Endian)
@<ttable> - <ttable> means a raw InterSystems character translation table name. A prefix of '@' means to use the named table.
• property Port as Ens.DataType.TCPAgentPort [ InitialExpression = 9192,Required ];
TCP Port to connect to

Methods


• method OnConnected() as %Status