Configuring Java CAPS Project Components for Communication Adapters

TCPIP Inbound Settings — TCP/IP Adapter Inbound

The TCPIP Inbound Settings properties provide the basic TCP/IP values for the server. The TCP/IP Inbound Settings properties contain the top-level parameters as displayed in the table.

Table 112 Connectivity Map - TCPIP Inbound Settings

Name 

Description 

Required Value 

Connection Type

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 certain 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 Client mode, leave this value as the default: Server.

ServerSO Timeout

Allows you to set or get the server SO_TIMEOUT value, in milliseconds.

The server's SO_TIMEOUT value is in milliseconds.

The default value is 10000 milliseconds (10 seconds).

Server Socket Factory Implementation Class Name

Enter the name of the Java class that implements the server socket factory. This class is used to create the server socket. If you have provided your own server 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

Keep Alive

Specifies whether the server’s SO_KEEPALIVE option is enabled or disabled. It is used for the accepted client socket.


Note –

For some properties, the server socket itself does not have direct properties settings associated with it. Instead, the properties map have direct properties settings associated to the accepted client socket.


Select True or False.

True indicates that the server SO_KEEPALIVE option is enabled.

The configured default is True.

Receive Buffer Size

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

A number indicating the receive buffer size. 

The configured default is 8192.

Send Buffer Size

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

A number indicating the send buffer size. 

The configured default is 8192.

SoLinger

Specifies whether the server's SO_LINGER option is enabled or disabled; used for the accepted client socket.

Select True or False.

True enables the SO_LINGER option.

The configured default value is True.

SoLinger Timeout

Specifies the server’s linger time-out in seconds. The maximum time-out value is platform specific. The setting only affects the socket close; used for the accepted client socket. 

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

SoTimeout

Allows you to set or get the value of the server's SO_TIMEOUT value, in milliseconds. Used for the accepted client socket.

A time-out of 0 (zero) is an infinite time-out. If you specify this value, the adapter goes into an infinite read. If this action happens, it is recorded in the adapter's log file. 

The SO_TIMEOUT value in milliseconds.

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

TcpNoDelay

Specifies whether the server’s TCP_NODELAY option (that is, Nagle’s algorithm) is enabled or disabled. Used for the accepted client socket.

Select True or False.

True enables the TCP_NODELAY option.

The configured default value is False.

Where to Go Next

TCPIP Inbound Settings - Server Port Binding — TCP/IP Adapter Inbound.

Related Topics