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 MsgBankProperty Inventory
Method Inventory
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
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 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.
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 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()
property ResponseTimeout as %Numeric (MINVAL = -1) [ InitialExpression = 120 ];
Number of seconds to wait for a response to begin arriving back from the remote system after sending a request.
Setting the timeout to -1 means wait forever.
The default is set to 2 minutes to account for possible large transmissions but long archiving times could be a signal of underlying issues.
Setting the timeout to -1 means wait forever.
The default is set to 2 minutes to account for possible large transmissions but long archiving times could be a signal of underlying issues.
Property methods: ResponseTimeoutDisplayToLogical(), ResponseTimeoutGet(), ResponseTimeoutIsValid(), ResponseTimeoutLogicalToDisplay(), ResponseTimeoutNormalize(), ResponseTimeoutSet()
Methods
method SendMessageStream(pRequestStream As %Stream.Object, ByRef pResponseString As %String = "", pHandShake As %Boolean = 0) as %Status
Inherited Members
Inherited Properties
- %CredentialsObj
- %WarnedLatest
- %lastRetryReconnect
- %logConnections
- BusinessHost
- ConnectTimeout
- Connected
- Credentials
- Device
- Endian
- GetReply
- IOAddr
- IPAddress
- KeepaliveInterval
- LocalInterface
- OldIO
- ReadTimeout
- ReconnectRetry
- RegistryID
- SSLConfig
- Socket
- StayConnected
- Terminators
- UseFileStream
Inherited 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()
- GetSettings()
- IsReadError()
- IsWriteError()
- OnInit()
- OnKeepalive()
- OnTearDown()
- ReadCountedStream()
- ReadCountedString()
- TestConnection()
- WriteCountedStream()
- WriteCountedString()