IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

TCPIPServer configurable service

Select the objects and properties that you want to change for the TCPIPServer configurable service.

For TCPIPServer configurable services, you must stop and start the integration server for a change of property value to take effect.

Supplied configurable services that are created for each broker Properties for each configurable service that is defined Description of properties

Default

CloseWithProcessedData

The default value is false. When set as false, the connection is kept open until all data on the connection is processed by a message flow. If you calculate the number of connections, these open connections count towards the total as shown in resource stats, or used to compare to MaximumConnections.

If the connection is never used again in a message flow, then the connection does not close, and there is the potential to exceed the maximum number of connections that is defined by MaximumConnections. You can set up an expiry, or set CloseWithProcessedData to True to clear up connections with unexpected extra data.

When the value is set to true, the integration node always closes a connection as soon as a close is received on the connection input stream, even if there is pending data to be processed. If your requirement is to close the connection immediately, even if there is pending data when a close happens on the socket, then set the value to true.

CloseWithUnprocessedData

The default value is false.

When the value is set to true, the Broker reads ahead up to 1 MB on the stream to look for TCP/IP close events from the steam. If a close event is encountered, then the connection is allowed to close if it is not owned by an input node. This process allows flows that contain connections that are owned by receive nodes to respond to TCP/IP close events, even if execution never proceeds to another Receive node (for example if the flow's input node is idle when the close occurs).

Port

The port number to be used for this configurable service. The default is 0 (zero), which means no port number. By default, the configurable service is disabled and the value of the port provided on the node is used instead.

A port number can be assigned to only one configurable service at a time; if you try to assign a port number to more than one configurable service, an error occurs.

MaximumConnections

The maximum number of server connections that can be made on this port. The default value is 100.

MaxReceiveRecordBytes

The maximum size a record can reach before an exception is thrown. The default value is 104857600, which means that, by default, the broker accepts messages with a maximum size of 100 MB. The record size is taken to be the size of the data including any delimiters.

ExpireConnectionSec

The length of time (in seconds) that a connection is kept open without being used. The value can be any integer. A value of 0 (zero) causes the connection to be closed immediately, and a value of -1 causes the connection to remain open indefinitely (no expiry).

SO_RCVBUF

The size (in bytes) of the SO_RCVBUF property on the socket. Valid values vary according to the operating system that you are using. This property is a standard TCP/IP property. The default value is 0 (zero), which sets the size of the SO_RCVBUF property to the operating system default.

SO_SNDBUF

The size (in bytes) of the SO_SNDBUF property on the socket. Valid values vary according to the operating system that you are using. This property is a standard TCP/IP property. The default value is 0 (zero), which sets the size of the SO_SNDBUF property to the operating system default.

SO_KEEPALIVE

The value of the KEEPALIVE property on the socket. If the value is set to True, the socket checks that it is still connected after a specified time. The length of time depends on the TCP/IP implementation on the operating system, but is typically two hours. Keep alive processing works only if the underlying operating system supports SO_KEEPALIVE. This property is a standard TCP/IP property. The default value is False, which means that no keep alive processing is performed.

TCP_NODELAY

The value of the TCP_NODELAY property on the socket. If the value is set to True, the socket sends data as soon as it is sent to its buffer. The default value is False.

TrafficClass

The traffic class on any connection that is established. Valid values are positive integers. The default value is -1, which leaves the TrafficClass set to the platform default.

SO_LINGER

The SO_LINGER property on any connection that is established. This property is a standard TCP/IP property. The default value is False.

SO_LINGER_TIMEOUT_SEC

The SO_LINGER_TIMEOUT_SEC property on any connection that is established. This property is a standard TCP/IP property. Valid values are positive integers. The default value is -1, which leaves the SO_LINGER_TIMEOUT_SEC value set to the operating system default.

SSLCiphers

A semicolon-delimited list of cipher suites that can be used for the SSL handshake. The default value "" means that all available cipher suites can be used.

SSLProtocol

The SSL protocol to use. Valid values are:
"", or none
SSL is not used. The default value.
SSL
Use SSL.
SSLv3
Use SSLv3.
TLS
Use TLS.
SSLClientAuth
Specify whether the client must provide authentication information about itself. Valid values are:
""
Client authentication is disabled. This value is the default.
want
Client authentication is requested. The connection is allowed even if the client does not give authorization information.
request
The same as want.
need
Client authentication is requested. If the client fails to give the required authorization information, the connection is closed.
require
The same as need.

SSLKeyAlias

The key alias that identifies the key in the broker or integration server keystore that is to be used for the SSL connection. Set this optional property if your keystore contains more than one key. The default value "", or none, means that an SSL key alias is not used. Any other string value identifies the alias.

Note: If the keystore contains more than one key, and no key alias is defined, the Java™ virtual machine arbitrarily chooses a key at run time.

bn28747_.htm | Last updated Friday, 21 July 2017