Home > Class Reference > ENSLIB namespace > Ens.Enterprise.MsgBank.ClientTCPAdapter

Ens.Enterprise.MsgBank.ClientTCPAdapter

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

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SETTINGS = -Endian,-Charset,-GetReply;
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 Charset as %String [ InitialExpression = "@UTF8" ];
Inherited description: 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 Ensemble 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 methods: CharsetDisplayToLogical(), CharsetGet(), CharsetIsValid(), CharsetLogicalToDisplay(), CharsetLogicalToOdbc(), CharsetNormalize(), CharsetSet()
property Port as %Integer (MAXVAL = 65535, MINVAL = 0) [ InitialExpression = 9192 , Required ];
TCP Port to connect to
Property methods: PortDisplayToLogical(), PortGet(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSet()

Methods (Including Private)

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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)