This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).


abstract class %IO.IParts.ServerSocketIO

Property Inventory (Including Private)

Method Inventory (Including Private)


property AllowedClientIPAddresses as %String (TRUNCATE = 1);
A comma-separated list of remote IP addresses to accept connections from optional. Accepts IP addresses in dotted decimal form for IPV4 and colon-hex form for IPV6, with optional :port for IPV4 and |port for IPV6, e.g., or fe80::4c60:9595:7fb3:8139, fe80::4c60:9595:7fb3:8139|3298.
If :port or |port is specified, connections from other ports at the associated address will be refused.
Property methods: AllowedClientIPAddressesDisplayToLogical(), AllowedClientIPAddressesGet(), AllowedClientIPAddressesIsValid(), AllowedClientIPAddressesLogicalToDisplay(), AllowedClientIPAddressesLogicalToOdbc(), AllowedClientIPAddressesNormalize(), AllowedClientIPAddressesSet()
property ConnectionQueueSize as %Integer (MINVAL = 0) [ InitialExpression = 1 ];
Number of connections that can queue up waiting for this server socket to attend to them.
Property methods: ConnectionQueueSizeDisplayToLogical(), ConnectionQueueSizeGet(), ConnectionQueueSizeIsValid(), ConnectionQueueSizeLogicalToDisplay(), ConnectionQueueSizeNormalize(), ConnectionQueueSizeSet()
property IsConnected as %Boolean [ ReadOnly ];
Is there a connection open from a remote client
Property methods: IsConnectedDisplayToLogical(), IsConnectedGet(), IsConnectedIsValid(), IsConnectedLogicalToDisplay(), IsConnectedNormalize()


method DefaultFlushOnWriteGet()
abstract method Listen(ByRef pTimeout As %Numeric = -1, Output pSC As %Status) as %Boolean
abstract method ListenJob(ByRef pTimeout As %Numeric = -1, pOnConnectedClass As %String, pJobArgs As %String, pSocketClass As %String = "%IO.ServerSocket", pMaxJobs As %Integer = -1, pForeground As %Boolean = 0, Output pSC As %Status) as %Integer
abstract method Open(pPort As %String, ByRef pTimeout As %Numeric = -1, Output pSC As %Status) as %Boolean