TCPIPClient configurable service

Default

Hostname

The host name of the remote system to which to connect with a client connection. A valid value is any IP address or computer name. You cannot change this value if there is already a configurable service with this name using the same port (unless the port is set to 0 (zero)).

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.

AlternativeAddresses

The list of secondary host names and ports to be tried if the main remote address fails. If no addresses are specified, only the main remote address is used. Addresses must be in the format hostname:port. If no port is specified, the main port number is used. Multiple addresses must be separated with semicolons; for example: jones6:1111;edwards

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).

MinimumConnections

The minimum number of client connections made by the broker. The broker attempts to establish this number of connections even if no flows are using the connections. The default value is 0 (zero), which means that the broker does not make any client connections until they are required.

MaximumConnections

The maximum number of client connections that can be made to this host and port. The default value is 100, which means that, there can be 100 concurrent connections open for use by TCPIPClientNode. When the maximum is reached, and all connections are in use, all other nodes are blocked until one of the connections becomes available for use or is closed. The length of time that the flow is blocked for can be controlled by configuring the property on the node Timeout sending a data record (seconds).

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 all 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).

UseUniqueConnectionPool

Specifies whether the connection pool corresponding to the configurable service is the main connection pool for the specified host name and port. You can have two connection pools for the same remote address, and you can use the UseUniqueConnectionPool property to specify whether the connection pool corresponding to this configurable service is the main connection pool.

The nodes in a message flow specify which pool to use by specifying the appropriate configurable service.

The host name and port specified in the node override the properties defined in the main configurable service only.

Possible values for this property are True and False. A value of True means that the connection pool for the configurable service is a separate connection pool rather than the main one. The value True is not case-sensitive.

By default, this property is set to False, which means that the configurable service defines the main connection pool. Any value other than True (including a null value) defaults to a value of False.

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.

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 that is set 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.

SSLProtocol

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.