TCP Open Connection

TCP Open Connection is a synchronous activity that opens a connection to a TCP server. After establishing the connection, the activity places a handle to the open connection in the connection output element. The subsequent activities in the process use this connection key for the TCP Connection to read data from, write data to, or close the connection.

General

The General tab has the following fields.

Field Literal Value/Module Property Description
Name None The name to be displayed as the label for the activity in the process.
TCP Connection Yes The TCP Connection is a shared configuration resource that specifies the connection information for the TCP server. Specify the required value in the TCP connection property.
Local Host None Specifies the IP address on the local machine to be used as the TCP client.
Timeout None Specifies a timeout value for the TCP Connection.
  • Default value : 0.
  • Lower limit : 1.
  • Upper limit : default OS timeout value.
Note: For default value and timeout value higher than the default OS timeout value, the timeout will occur within the OS default timeout.

Description

Provide a short description for the activity.

Input

The following is the input for the activity.

Input Item Datatype Description
connection complex An optional element. This element contains the information about the TCP server you want to connect to. It comprises host, port, and localhost elements.
host string An optional element. The name or IP address of the TCP server you want to connect to.

This value overrides the value specified by the TCP connection property in the General tab.

port number An optional element. The port number on which the TCP server is listening for requests.

This value overrides the value specified by the TCP connection property in the General tab.

localhost string An optional element. The name or the IP address of the TCP client.

Output

The following is the output of the activity.

Output Item Datatype Description
connection binary The handle to the open connection.

The subsequent activities in the process use this connection key to read data from, write data to, or close the connection.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more information about error codes and the corrective action to take, see the TIBCO ActiveMatrix BusinessWorks™ Error Codes guide.

Fault Generated When..
TCPActivityFault There is some problem associated with the activity at runtime.