RecoveryTimeout Property (TdConnectionStringBuilder)

Recovery timeout in seconds used to re-establish a connection.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property RecoveryTimeout As Integer

'Usage
 
Dim instance As TdConnectionStringBuilder
Dim value As Integer
 
instance.RecoveryTimeout = value
 
value = instance.RecoveryTimeout

public int RecoveryTimeout {get; set;}

public:
property int RecoveryTimeout {
   int get();
   void set (    int value);
}

Remarks

The RecoveryTimeout is used if the CommandTimeout is infinite or the TdConnectionStringBuilder.RecoveryCommandTimeoutOverride is enabled while the TdCommand.CommandTimeout is non-zero.

If the CommandTimeout is 0, the reconnection timeout will always be extended by the RecoveryTimeout value in the application configuration file or the default value if not provided in the application configuration file.

If the CommandTimeout is non-zero, the reconnection timeout will be extended by the RecoveryTimeout value when RecoveryCommandTimeoutOverride is true. Otherwise if the RecoveryCommandTimeoutOverride is false and the CommandTimeout is finite, only the time remaining in the CommandTimeout will be used to reconnect.

Asynchronous commands do not contain or use CommandTimeouts. Asynchronous commands will always use the RecoveryTimeout in reconnection.

The value of the RecoveryTimeout is determined based upon :

The RecoveryTimeout defined here
The RecoveryTimeout obtained from evaluating the TdConnectionStringBuilder.ProfileName
The default value

The TdConnection.RecoverConnection event enables applications to change the RecoveryTimeout value that has been determined from the above hierarchy. The TdRecoveryEventArgs.RecoveryTimeout may be supplied by an application listening for the TdConnection.RecoverConnection event. It will always be activated during recovery in the initial attempt and during subsequent attempts after a calculated delay period. The TdConnection.RecoverConnection event is activated when either of the following is true during reconnection:

CommandTimeout is infinite
CommandTimeoutOverride is true
The command is asynchronous

If the event is activated again because the initial RecoveryTimeout expired, and the application is not listening, no additional time will be provided for reconnection and the reconnection will fail.

Default Value: 1200 seconds

Requirements

Target Platforms: Windows 8.1, Windows 10, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019

Reference

TdConnectionStringBuilder Class
TdConnectionStringBuilder Members