Specifies the maximum amount of data that the programs can hold internally.

The valid range is from 1 to 2147483647 bytes (2 GB — the maximum value of the Java integer).

The configured default is 2147483647.

Specifies the scope of State object, which is an OTD node. The options for this parameter are:

• Resource Adapter Level: The State has the same life cycle as the resource adapter.

• Persistence: The State is persisted in the storage media like file or DB (Persistence State File Location must be specified if this option is selected).

• Connection Level: The State has the same life cycle as the connection.

• OTD Level: The State has the same life cycle as the OTD object.

  This scope represents the life cycle of the State.

Select one of the following:

• Resource Adapter Level

• Connection Level

• OTD Level

The configured default is Resource Adapter Level.

Specifies how the adapter establishes the TCP/IP connection:

• Client: The adapter connects to an external server (host/port) to establish the connection. The adapter is in active mode.

• Server: The adapter waits/listens on a particular port for an incoming connection request from an external client. Once the request is received, the adapter accepts the request and establishes the connection. The adapter is in passive mode.

Select Client or Server. Server is the default setting.

Unless you specifically require Server mode, leave this value as the default: Client.

Sets or gets the value of the SoTimeout for the ServerSocket, in milliseconds. Used for ServerSocket.accept(). When you set this option to a non-zero timeout, calling accept() for ServerSocket will block for only this period of time. If the timeout expires, a java.net.SocketTimeoutException (or java.net.InterruptedIOException) is thrown, though the ServerSocket remains valid.

Enable this option prior to entering the blocking operation. This parameter is used only when the Connection Type is set as Server.

An integer that indicates the SoTimeout value in milliseconds.

The default value is 60000 milliseconds (60 seconds).

The timeout must be greater than 0 (zero). A timeout value of 0 is interpreted as an infinite timeout.

Specifies whether the client’s SO_KEEPALIVE option is enabled or disabled. True indicates that the server SO_KEEPALIVE option is enabled.

Select True or False.

The configured default is True.

Allows you to set or get the value of the client SO_RCVBUF option for the current socket, that is, the buffer size used by the operating system for input on this socket. It sets a hint as to the size of the underlying buffers used by the platform for incoming network I/O.

When used in set, this is a suggestion to the kernel, from the application, regarding the buffer sizes to use for the data that will be received over the socket.

When used in get, this must return the size of the buffer actually used by the platform when receiving in data on this socket.

An integer indicating the receive buffer size.

The configured default is 8192.

Allows you to set or get the value of the client's SO_SNDBUF option for the current socket, that is, the buffer size used by the operating system for output on this socket.

A number indicating the send buffer size.

The configured default is 8192.

Specifies whether the client's SO_LINGER option is enabled or disabled.

Select True or False.

True enables the SO_LINGER option.

Specifies the client’s linger timeout in seconds. The maximum timeout value is platform specific. The setting only affects the socket close.

The linger timeout in seconds. The configured default is 30 seconds, indicating that the SO_LINGER option is disabled.

Allows you to set or get the value of the client's SO_TIMEOUT value, in milliseconds.

The SO_TIMEOUT value in milliseconds.

The configured default value is 10000 milliseconds (10 seconds).

Specifies whether the client’s TCP_NODELAY option (that is, Nagle’s algorithm) is enabled or disabled.

Select True or False.

True enables the TCP_NODELAY option.

Enter the name of the Java class that implements the client socket factory. This class is used to create the client socket. If you have provided your own client socket implementation, enter the name of the Java class that contains this implementation. The factory implementation class must implement the following interface:

com.stc.connector.tcpip.model.factory.
TCPIPSocketFactory

A valid Java class name; the default is:

com.stc.connector.tcpip.model.
factory.TCPIPSocketFactoryIm
pl

Specifies the length of time (in milliseconds) the adapter waits before attempting to connect to the external system.

A number indicating the amount of time (in milliseconds) the adapter waits before attempting to connect.

The configured default is 0.

Specifies whether the adapter always attempts to create a new connection when a connection establishment request is received.

• True indicates that the adapter always attempts to create a new connection without attempting to match an existing connection.

• False indicates that the adapter attempts to match an existing connection (managed by the container).

Select True or False.

The configured default is False.

Specifies whether to attempt to re-connect automatically when the adapter gets a matching connection from a container, even though this connection is not valid due to various reasons: for example, the external side of the connection is closed/reset due to the external application's logic.

This property only takes effect when the application server has an existing connection in its connection pool, not during an initial triggering when the pool is empty.

• True indicates that the adapter discards the invalid matching connection and automatically attempts to reconnect using a new connection.

• False indicates that the adapter does not automatically attempt to reconnect using a new connection: instead, a exception is thrown and the adapter raises the appropriate alert. The user must detect this type of failure and act appropriately.

Select True or False.

The configured default is True.

Specifies the maximum number of times the adapter attempts to connect to a specific external TCP/IP destination (host/port) before giving up.

An integer indicating the number of times the adapter attempts to connect.

Specifies the amount of time (in milliseconds) the adapter waits between attempts to connect to a specific external TCP/IP destination (host/port).

An integer indicating the amount of time (in milliseconds) the adapter waits between attempts to connect. The configured default is 30000 (or 30 seconds).

Specifies the maximum number of times the adapter attempts to bind to the specified TCP/IP port on the localhost.

An integer indicating the number of bind attempts to the specified TCP/IP port on the localhost.

Specifies the amount of time (in milliseconds) the adapter waits between attempts to bind to the specified TCP/IP port on the localhost.

An integer indicating the amount of time in milliseconds that the adapter attempts to bind to the specified TCP/IP port.

The configured default is 30000 (30 seconds).

Specifies the envelope type. The envelope type defines where a message starts and stops.

Enter one of the following properties denoting the envelope type:

• BeginEndMarked

• EndMarked

• FixedLength

• LengthPrefixed

• MarkedAndFixed

• PerActiveConnection

• Custom

The default is BeginEndMarked.

BeginEndMarked is supported by the properties Bytes to Read, Ignore Until Char Value, and Store Until Char Value.

EndMarked is supported by the property Store Until Char Value.

FixedLength is supported by the property Bytes to Read.

LengthPrefixed is supported by the properties Width of Length and Numeric Representation.

MarkedAndFixed is supported by the property Bytes to Read, Ignore Until Char Value, and Store Until Value.

PerActiveConnection is supported by the property PerActiveConnection.

Custom is supported by the properties Custom Enveloped Class Name and Custom Defined Property.

For optimum performance, use the method receiveEnvelopedMsg() with any enveloped messages. This method uses the envelope as its ending condition, while the other receiving methods, receiveBytes() and receiveString(), use a timeout as their ending condition.

Specifies the Java class name to be used when the Envelope Type property is set to Custom.

If you are using a custom envelope you have created, using a Java Class, you can import the Java JAR file containing the class into any desired Collaboration, using the Collaboration Editor's file import feature.

The class name should be a full qualified class name, such as com.abc.MyClass. The class must implement interfaces

com.stc.connector.tcpip.ext.msg.
EnvelopedMsgReceiver

and

com.stc.connector.tcpip.ext.msg.
EnvelopedMsgSender

For more details, see Customized Enveloping.

A full Java class name.

A full qualified class name, or None if Custom is not the Envelope Type.

The configured default is None.

Used when the Envelope Type value is set to Custom. Specifies a list of user-defined parameters. You can parse this information, such as delimiters, into your customized envelope message implementation.

A text string.

Used with the following Envelope Types:

• FixedLength

• MarkedAndFixed

Specifies the number of bytes to read. It is assumed that all Events received by the adapter have the same length.

An integer indicating the number of bytes.

The configured default is 1.

Used for Envelope Type value LengthPrefixed. Specifies the width of the envelope length. In other words, it dictates the number of digits to be used to represent the length field.

An integer, the range is 1 to 10. This property must be set to 2 for Network short and 4 for Network long.

The configured default value is 1.

Used for Envelope Type value LengthPrefixed. Specifies how the number representation of the prefixed length is expressed. This value is expressed in one of the following formats:

• Decimal

• Hexadecimal

• Octal

• Network Short

• Network Long

Select one of the following:

• Decimal

• Hexadecimal

• Octal

• Network Short

• Network Long

The configured default is Decimal.

Used for the Envelope Types BeginEndMarked and MarkedAndFixed. Specifies the value for the ignore-until (same as begin block) character. All incoming characters are ignored until this character is encountered.

A decimal ASCII number. The allowed range is 1 to 127.

The configured default is 11.

Used for Envelope Types BeginEndMarked, EndMarked, and MarkedAndFixed. Specifies the character in the End Block or Marker position of the envelope. All incoming characters are stored until this character is encountered.

A decimal ASCII number. The allowed range is 1 to 127.

The configured default is 12.