Class Reference
EnsLib.EDI.X12.Adapter.TCPInboundAdapter
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [EnsLib] >  [EDI] >  [X12] >  [Adapter] >  [TCPInboundAdapter]
Private  Storage

class EnsLib.EDI.X12.Adapter.TCPInboundAdapter extends EnsLib.TCP.InboundAdapter

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 3


Summary

Properties
%CredentialsObj %OutLine %PoolLimit %WarnedLatest
%logConnections %outIPAddr AllowedIPAddresses BusinessHost
CallInterval Connected Credentials Device
IOAddr JobPerConnection KeepaliveInterval LocalInterface
OldIO Port QSize ReadTimeout
RegistryID SSLConfig Socket StayConnected
Terminators

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
ConnectOut ConnectedSet CredentialsSet Disconnect
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch FlushWrite
GetAddress GetSettings IsReadError IsWriteError
OnConnected OnInit OnKeepalive OnTask
OnTearDown TestConnection connectedJob


Properties

• property %OutLine as %String;
Local holder for lookahead line for Parser
• property JobPerConnection as %Boolean [ InitialExpression = 0 ];
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.
• property QSize as %Integer(MAXVAL=1000,MINVAL=0) [ InitialExpression = 0 ];
How many incoming connections should the OS hold open until the Business Service processes them.

The default QSize for the X12 TCP inbound adapter is 0, which supports the X12 FIFO strategy where only one connection at a time is expected and subsequent connections ought to be refused immediately.
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.

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.


Methods

• method Disconnect()
• method OnConnected() as %Status
• method OnInit() as %Status
This user callback method is called just after %OnNew()


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.