Skip to main content

%IO.IParts.ServerSocketIO

Class %IO.IParts.ServerSocketIO [ Abstract, System = 2 ]

Properties

IsConnected

Property IsConnected As %Boolean [ ReadOnly ];

Is there a connection open from a remote client

AllowedClientIPAddresses

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. 192.168.1.22, 192.168.1.22:3298 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.

ConnectionQueueSize

Property ConnectionQueueSize As %Integer(MINVAL = 0) [ InitialExpression = 1 ];

Number of connections that can queue up waiting for this server socket to attend to them.

Methods

DefaultFlushOnWriteGet

Method DefaultFlushOnWriteGet() [ CodeMode = expression ]

Listen

Method Listen(ByRef pTimeout As %Numeric = -1, Output pSC As %Status) As %Boolean [ Abstract ]

ListenJob

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 ]

Open

Method Open(pPort As %String, ByRef pTimeout As %Numeric = -1, Output pSC As %Status) As %Boolean [ Abstract ]