Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [Ens] >  [Enterprise] >  [MsgBank] >  [ClientTCPAdapter]
Private  Storage   

class Ens.Enterprise.MsgBank.ClientTCPAdapter extends EnsLib.TCP.OutboundAdapter, EnsLib.TCP.CountedCommon

Block-oriented TCP Outbound Adapter used by MsgBank clients to submit messages to the MsgBank

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 2


Summary

Properties
%CredentialsObj %WarnedLatest %lastRetryReconnect %logConnections
BusinessHost Charset ConnectTimeout Connected
Credentials Device Endian GetReply
IOAddr IPAddress KeepaliveInterval LocalInterface
OldIO Port ReadTimeout ReconnectRetry
RegistryID 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
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
Connect ConnectedSet CredentialsSet Disconnect
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch FlushWrite
GetAddress GetReplyString GetSettings IsReadError
IsWriteError OnInit OnKeepalive OnTearDown
ReadCountedStream ReadCountedString SendMessageStream TestConnection
WriteCountedStream WriteCountedString


Parameters

• parameter SETTINGS = "-Endian,-Charset,-GetReply";
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 %Integer(MAXVAL=65535,MINVAL=0) [ InitialExpression = 9192,Required ];
TCP Port to connect to

Methods

• method GetReplyString(ByRef pResponseString As %String = "") as %Status
• method SendMessageStream(pRequestStream As %Stream.Object, ByRef pResponseString As %String = "", pHandShake As %Boolean = 0) as %Status

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.