Skip to main content


abstract class EnsLib.TCP.Common extends %Library.RegisteredObject

Property Inventory

Method Inventory


parameter InputBufferSize = 32767;
parameter Mode = S;
The Device Mode that will be used to open the TCP socket
parameter OutputBufferSize = 32767;
parameter SETTINGS = StayConnected:Connection,ReadTimeout:Connection,SSLConfig:Connection:sslConfigSelector,LocalInterface:Connection:selector?context={Ens.ContextSearch/TCPLocalInterfaces};


property %logConnections as %Boolean [ InitialExpression = 1 ];
Local flag controlling logging of connection and disconnection events.
Property methods: %logConnectionsDisplayToLogical(), %logConnectionsGet(), %logConnectionsIsValid(), %logConnectionsLogicalToDisplay(), %logConnectionsNormalize(), %logConnectionsSet()
property Connected as %Boolean [ InitialExpression = 0 ];
Property methods: ConnectedDisplayToLogical(), ConnectedGet(), ConnectedIsValid(), ConnectedLogicalToDisplay(), ConnectedNormalize(), ConnectedSet()
property Device as %String;
Property methods: DeviceDisplayToLogical(), DeviceGet(), DeviceIsValid(), DeviceLogicalToDisplay(), DeviceLogicalToOdbc(), DeviceNormalize(), DeviceSet()
property IOAddr as %String;
String naming remote TCP/IP address:port, and local port if applicable
Property methods: IOAddrDisplayToLogical(), IOAddrGet(), IOAddrIsValid(), IOAddrLogicalToDisplay(), IOAddrLogicalToOdbc(), IOAddrNormalize(), IOAddrSet()
property LocalInterface as %String (MAXLEN = 250);
In a multi-homed system, specify which network interface the TCP connection should go through. An empty value means to use any interface.
To be able to bind to IPv6 interfaces you may need to enable IPv6 in your InterSystems IRIS instance. This is done in the System Management Portal under System Administration > Configuration > Additional Settings > Startup, by editing the IPv6 setting.
Property methods: LocalInterfaceDisplayToLogical(), LocalInterfaceGet(), LocalInterfaceIsValid(), LocalInterfaceLogicalToDisplay(), LocalInterfaceLogicalToOdbc(), LocalInterfaceNormalize(), LocalInterfaceSet()
property OldIO as %String (MAXLEN = 1000) [ InitialExpression = 0 ];
Property methods: OldIODisplayToLogical(), OldIOGet(), OldIOIsValid(), OldIOLogicalToDisplay(), OldIOLogicalToOdbc(), OldIONormalize(), OldIOSet()
property ReadTimeout as %Numeric (MINVAL = 0) [ InitialExpression = 5 ];
Number of seconds to wait for each successive incoming TCP read, following receipt of initial data from remote TCP port.
Property methods: ReadTimeoutDisplayToLogical(), ReadTimeoutGet(), ReadTimeoutIsValid(), ReadTimeoutLogicalToDisplay(), ReadTimeoutNormalize(), ReadTimeoutSet()
property SSLConfig as %String;
The name of an existing SSL/TLS system configuration to use (Secure Socket Layer / Transport Layer Security), which can be configured in the System Management Portal under System Administration > Security.

If your SSL Configuration requires you to supply a password for the local private key file, specify it in the Private key password property of the SSL/TLS Configuration.

Property methods: SSLConfigDisplayToLogical(), SSLConfigGet(), SSLConfigIsValid(), SSLConfigLogicalToDisplay(), SSLConfigLogicalToOdbc(), SSLConfigNormalize(), SSLConfigSet()
property Socket as %IO.DeviceStream;
IOStream object for TCP device
Property methods: SocketGet(), SocketGetSwizzled(), SocketIsValid(), SocketNewObject(), SocketSet()
property StayConnected as %Numeric (MINVAL = -1) [ InitialExpression = -1 ];
The default value of -1 means to stay permanently connected, even during idle times, and treat a disconnection as an error.
If the value is a positive number, then the adapter will stay connected to the remote system between handling requests until idle for this number of seconds.
A zero value means to disconnect immediately after every input event.
Property methods: StayConnectedDisplayToLogical(), StayConnectedGet(), StayConnectedIsValid(), StayConnectedLogicalToDisplay(), StayConnectedNormalize(), StayConnectedSet()
property Terminators as %String;
Read-terminator character or characters, if any, for subclasses that do terminated reads.
Property methods: TerminatorsDisplayToLogical(), TerminatorsGet(), TerminatorsIsValid(), TerminatorsLogicalToDisplay(), TerminatorsLogicalToOdbc(), TerminatorsNormalize(), TerminatorsSet()


classmethod FlushWrite()
method GetAddress() as %String
classmethod IsReadError(pSC As %Status) as %Boolean
classmethod IsWriteError(pSC As %Status) as %Boolean

Inherited Members

Inherited Methods


FeedbackOpens in a new tab