tibemsConnectionFactory_SetConnectAttemptTimeout

Function

Purpose

Modify the connection timeout setting.

C Declaration

tibems_status tibemsConnectionFactory_SetConnectAttemptTimeout(
    tibemsConnectionFactory factory,
    tibems_int timeout );

COBOL Call

CALL "tibemsConnectionFactory_SetConnectAttemptTimeout"
     USING BY VALUE factory,
           BY VALUE timeout,
           RETURNING tibems-status
END-CALL.
Note: factory has usage pointer.

Parameters

Parameter Description
factory Set the connection timeout parameter of this connection factory.
timeout This value determines the maximum time (in milliseconds) the client will wait for a connection to the server to be established.

The minimum permitted timeout is 100 milliseconds. However, under stress conditions, this minimum may be too low to enable reliable connection creation. In such cases, a value of greater than 1000 is suggested. Zero is a special value, which specifies no timeout.

Note that the maximum can be exceeded if the timeout is set to be less than 1000. If the value provided is less than 1000, the creation of the socket is subject to its own minimum of 1 second, which can impact the timeout.

When this property is not set, the default value is 0.

See Also

tibemsConnectionFactory_SetConnectAttemptCount

tibemsConnectionFactory_SetConnectAttemptDelay

Set Connection Attempts, Timeout and Delay Parameters in the TIBCO Enterprise Message Service User’s Guide