Home > Class Reference > ENSLIB namespace > EnsLib.EDI.ASTM.Adapter.TCPAdapter
Private  Storage   

EnsLib.EDI.ASTM.Adapter.TCPAdapter


class EnsLib.EDI.ASTM.Adapter.TCPAdapter extends EnsLib.TCP.InboundAdapter

As specialized ASTM 2-way Adapter based on TCPInboundAdapter

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15 5


Summary


Properties
%CredentialsObj %InSeparators %PoolLimit %WarnedLatest
%logConnections %outIPAddr AllowedIPAddresses BusinessHost
CallInterval Connected Credentials Device
GetReply IOAddr JobPerConnection KeepaliveInterval
LocalInterface OldIO OutQueueName OutSeparators
Port QSize ReadTimeout RegistryID
ResponseTimeout 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


Parameters


• parameter SETTINGS = "ResponseTimeout,OutSeparators,GetReply";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties


• property %InSeparators as %String(MAXLEN=4,MINLEN=4);
Remember separators from last input document
• property GetReply as %Boolean [ InitialExpression = 1 ];
The default is to get a reply but if the external system does not provide a reply turn this flag off.
• property OutQueueName as %String [ ReadOnly ];
• property OutSeparators as %String(MAXLEN=4,MINLEN=4) [ InitialExpression = "Flex" ];
Separator characters to use when sending outbound ASTM documents.

'Flex' means copy the separators from inbound messages, or use the native separators of the outbound message if outbound goes first.

• property Port as Ens.DataType.TCPAgentPort [ InitialExpression = 10001,Required ];
TCP Port to connect to. To listen instead of intiating a connection, configure AllowedIPAddresses=!IPaddr.
• property ResponseTimeout as %Numeric(MINVAL=-1) [ InitialExpression = 15 ];
Number of seconds to wait for a response to begin arriving back from the remote system after sending a request. Setting the timeout to -1 means wait forever.
• property Terminators as %String [ InitialExpression = $C(10) ];
Read-terminator character or characters, if any, for subclasses that do terminated reads.

Methods


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