Copyright © Cloud Software Group, Inc. All Rights Reserved

TCP Connection

Shared Configuration

The TCP Connection is a shared configuration resource that specifies the connection information for the TCP server. This resource is used when a process definition acts as a TCP client connecting to a remote server or when a process definition acts as a TCP server accepting incoming TCP connections.

Configuration

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
Host	No	When a process definition acts as a client, this field specifies the host name or host IP address of the TCP server to connect to. When a process definition acts as a server, this field specifies the hostname or IP address of the machine where the process engine is running. You can specify "localhost" or if the machine has more than one network interface card, you can specify the IP address of the card you want to use to accept TCP/IP connections.
Port	Yes	This field specifies the port number on which a TCP server is listening for requests.
Enable Pooling (client side)	No	Specifies whether connection pooling should be enabled on the client side. Selecting this check box enables the WhenExhaustedAction, Maximum Connections, maxwaitTime and idleTimeout fields. By default, connection pooling is disabled. See Connection Pooling for more information.
WhenExhaustedAction	No	Specify the action to be taken when the maximum number of connections is consumed and the connection pool is exhausted: • Fail:When the pool is exhausted, the TCP Open Connection fails and an exception is thrown. • Grow:When the pool is exhausted, a new connection is created. There is no limit to the number of TCP connections in the pool. • Block:When the pool is exhausted, the TCP Open Connection activity is blocked until a new connection is available, or till the maximum wait time is reached. The default value is Block.
Maximum Connection	Yes	This field is available when the action Fail or Block is selected in the field WhenExhaustedAction. Specifies the maximum number of TCP Connections in a pool. The default is 10.
maxWaitTime(in ms)	Yes	This field is available when the Block action is selected in the field WhenExhaustedAction. Specifies the maximum amount of time the TCP Open Connection activity must wait till it gets a connection from the pool. When less than or equal to 0, it may be blocked indefinitely. The default is 10 seconds.
idleTimeout (in ms)	Yes	Specifies the minimum amount of time a TCP Connection may sit idle in the pool before it is eligible for eviction. The default is -1. When less than or equal to 0 the eviction is disabled.

Advanced

The Advanced tab has the following fields

Field	Global Var?	Description
enableDNSLookup	No	Selecting this field enables a Domain Name System (DNS) lookup so that the IP address is resolved to a DNS name. This can adversely affect the throughput, so enable this field only when required.

Connection Pooling

When you enable pooling, TIBCO ActiveMatrix BusinessWorks creates a pool of TCP connections. TCP Connection pooling is available only on the client side and is disabled by default.

The maximum size of the pool can be specified using the Maximum Connection configuration field. A separate pool of TCP connections is created for every shared resource.

When pooled connections are required, the TCP Open Connection activity retrieves the connections from the pool. A check to identify stale connections is also done at the time of retrieval. Connections when freed are returned to the pool by the TCP Close Connection activity.

Overriding the host, port or local host values in the TCP Open Connection activity results in the creation of connections outside the pool, even if pooling is enabled on the referred shared resource.

Copyright © Cloud Software Group, Inc. All Rights Reserved