NTCP Read Agent Service (com.ibi.agents.XDNTCPReadAgent)

Syntax:

com.ibi.agents.XDNTCPReadAgent

iIT Service Object:

format: NTCP Read Agent

Description: Reads from a TCP connection until it receives a message or times out.

Parameters:

Parameter

Description

Host *

The remote host from which the service will attempt to read a message.

Port *

The TCP Port on Host from which the service will attempt to read a message.

Cache Socket Locally *

If true, cache the socket locally for reuse by other agents in the same process flow. This option is not allowed with the Message ends at EOS Message Protocol.

Response Timeout

The maximum time, in milliseconds, to block while waiting for a response from the server. 0 means no timeout. A negative value will use the system default.

TCP Connection Provider *

The name of the TCP Connection Provider to use for message emit.

Persist Connections?

If true, use a connection from the TCP Connection Provider's pool and return the connection to the pool after emit. If false, a new connection will be created for this emit and closed after emit is complete. Use of persistent connections is not allowed with the Message ends at EOS Message Protocol.

Message Protocol *

Choose one of the built-in options or use a custom handler. For the Message ends at EOS option, you must set Persistent Connections? to false and you must not use an SSL connection. To use a custom handler, supply the fully qualified name of a class that implements com.ibi.edaqm.IClientProtocolHelper and ensure that the class is on iSM's runtime classpath.

Maximum Incoming Size

On receipt of an incoming message larger than the maximum, the message will be ignored and the connection is closed. 0 means no maximum. Empty defaults to 256KB.

Edges:

The following table lists the available Line Edges for the NTCP Read Agent Service (com.ibi.agents.XDNTCPReadAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnFailConnection

Could not connect to the external system.

OnParseError

Could not parse a document.

OnFailedOperation

Could not perform the operation requested.