Skip to main content


abstract class EnsLib.TCP.InboundAdapter extends Ens.InboundAdapter, EnsLib.TCP.Common

A generic, protocol-agnostic TCP adapter. Handles making connections. Traffic content is up to the associated Business Service class.

Property Inventory

Method Inventory


parameter OpenTimeout = 5;
parameter SETTINGS = Port:Basic,JobPerConnection:Connection,AllowedIPAddresses:Connection,QSize:Connection;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names
parameter SINGLEPOOLJOB = 1;
Force a single listener job regardless of PoolSize setting


property %PoolLimit as %Integer;
Property methods: %PoolLimitDisplayToLogical(), %PoolLimitGet(), %PoolLimitIsValid(), %PoolLimitLogicalToDisplay(), %PoolLimitNormalize(), %PoolLimitSet()
property %outIPAddr as %String;
Property methods: %outIPAddrDisplayToLogical(), %outIPAddrGet(), %outIPAddrIsValid(), %outIPAddrLogicalToDisplay(), %outIPAddrLogicalToOdbc(), %outIPAddrNormalize(), %outIPAddrSet()
property AllowedIPAddresses as %String (MAXLEN = 1000);
Optional comma-separated list of remote IP addresses to accept connections from.

You may enter a comma-separated list of remote IP addresses to accept connections from, with 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.

If AllowedIPAddresses starts with a '!', the Adapter will initiate a connection to the specified address. In this case only one address may be given. If a port is included, it will supersede the value of the Port setting; otherwise the Port setting will be used to connect to the remote system.

Leaving this value empty means connections will be accepted from any remote IP address.

Property methods: AllowedIPAddressesDisplayToLogical(), AllowedIPAddressesGet(), AllowedIPAddressesIsValid(), AllowedIPAddressesLogicalToDisplay(), AllowedIPAddressesLogicalToOdbc(), AllowedIPAddressesNormalize(), AllowedIPAddressesSet()
property JobPerConnection as %Boolean [ InitialExpression = 1 ];
Spawn a new Job to handle each incoming TCP connection. Allows simultaneous handling of multiple connections.
Note that the performance of this setting can be affected by changing the configured QSize setting of this adapter and by configuring Job Servers as a system configuration option. Note also that when JobPerConnection=1, PoolSize is used to limit the number of connection jobs if it is configured with a value greater than 1.
Property methods: JobPerConnectionDisplayToLogical(), JobPerConnectionGet(), JobPerConnectionIsValid(), JobPerConnectionLogicalToDisplay(), JobPerConnectionNormalize(), JobPerConnectionSet()
property Port as Ens.DataType.TCPAgentPort [ Required ];
TCP Port to connect to (integer value below 65536), may be prepended with @AgentName:
Property methods: PortDisplayToLogical(), PortGet(), PortIsValid(), PortLogicalToDisplay(), PortLogicalToOdbc(), PortNormalize(), PortSet()
property QSize as %Integer (MAXVAL = 1000, MINVAL = 0) [ InitialExpression = 100 ];
How many incoming connections should the OS hold open until the Business Service processes them.

The default value is 100 and the maximum allowed value is 1000.
However, the maximum incoming connections the OS can hold open until the Business Service processes them depends on the TCP implementation.

Set to 0 if only one connection at a time is expected and subsequent connections ought to be refused immediately by the OS.

Note: If QSize is 0 a client attempting to connect will be refused connection by the operating system (RST,ACK) if the Business Service is processing a previous incoming connection.
This could lead to a scenario where a client is connected to the Business Service but disconnects and attempts to reconnect again in the brief period before the listening socket is re-opened by the Business Service and the client does not retry to connect as a result.

Property methods: QSizeDisplayToLogical(), QSizeGet(), QSizeIsValid(), QSizeLogicalToDisplay(), QSizeNormalize(), QSizeSet()


method ConnectOut(pTimeout As %Numeric) as %Status
method ConnectedSet(pValue As %Boolean) as %Status
method Disconnect()
abstract method OnConnected() as %Status
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method OnKeepalive(pUnused As %Status) as %Status
Inherited description: This method is called from the Host.OnTask() method. It will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive().
method OnTask() as %Status
Inherited description: default InboundAdapter behavior: always call ProcessInput on CallInterval
method OnTearDown() as %Status
Inherited description: This user callback method is called just before %OnClose()
method TestConnection()
Fix up the properties reflecting our connection state in case we thought we were connected but we lost the socket.
classmethod connectedJob(pBusinessServiceConfigName As %String, pPoolLimit As %Integer) as %Status

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab