Wait for TCP Request

The Wait for TCP Request activity waits for a TCP client connection request. When a connection request occurs, the activity places a handle to the open connection in the connectioney output element. This connection key can be used by subsequent activities in the process definition to read data from, write data to, or close the connection.

See Scalability With Incoming Events in TIBCO ActiveMatrix BusinessWorks Process Design Guide for information on running the "Wait for..." activities in a multi-engine mode.

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.
TCP Connection	No	The TCP Connection shared configuration resource that describes port on which the local machine is listening for incoming TCP/IP requests.
Keep-Alive	No	To specify whether the TCP connections should use the keep-alive feature of sockets, select the Keep-Alive check box. Note - TCP Keep-Alive is different from HTTP Keep-Alive.

The name to appear as the label for the activity in the process definition.

Description

Short description of the activity.

TCP Connection

The TCP Connection shared configuration resource that describes port on which the local machine is listening for incoming TCP/IP requests.

Keep-Alive

To specify whether the TCP connections should use the keep-alive feature of sockets, select the Keep-Alive check box.

Note - TCP Keep-Alive is different from HTTP Keep-Alive.

The Event tab has the following fields.

Field	Description
Candidate Event Key	This field cannot be used. Specifying a value in this field will not cause the value to be compared with the key field in the activity input.
Event Timeout (msec)	A message may arrive before this activity is executed. This field specifies the amount of time (in milliseconds) a message waits if it is received before this activity is executed. If the event timeout expires, an error is logged and the event is discarded. If no value is specified in this field, the message waits indefinitely. If zero is specified, the event is discarded immediately, unless this activity has already been reached.

Field

Description

Candidate Event Key

This field cannot be used. Specifying a value in this field will not cause the value to be compared with the key field in the activity input.

Event Timeout (msec)

A message may arrive before this activity is executed. This field specifies the amount of time (in milliseconds) a message waits if it is received before this activity is executed. If the event timeout expires, an error is logged and the event is discarded.

If no value is specified in this field, the message waits indefinitely. If zero is specified, the event is discarded immediately, unless this activity has already been reached.

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

Input Item	Datatype	Description
key	string	This element cannot be used. Specifying a value for this element will not cause the value to be compared to the value of the Candidate Event Key field on the Event tab.
processTimeout	integer	The time (in milliseconds) to wait for the incoming TCP request. An error is returned if the request is not received in this time limit.

This element cannot be used. Specifying a value for this element will not cause the value to be compared to the value of the Candidate Event Key field on the Event tab.

processTimeout

integer

The time (in milliseconds) to wait for the incoming TCP request. An error is returned if the request is not received in this time limit.

Output Item	Datatype	Description
connection	binary	The handle to the open connection. This connection key can be used by subsequent activities in the process definition to specify the TCP connection to write data to, read data from, or close.

The handle to the open connection. This connection key can be used by subsequent activities in the process definition to specify the TCP connection to write data to, read data from, or close.