SqlConnectionStringBuilder.LoadBalanceTimeout Property

  • Reference

Definition

Namespace:
Microsoft.Data.SqlClient
Assembly:
Microsoft.Data.SqlClient.dll
Package:
Microsoft.Data.SqlClient v1.0.19269.1
Package:
Microsoft.Data.SqlClient v1.1.4
Package:
Microsoft.Data.SqlClient v2.0.1
Package:
Microsoft.Data.SqlClient v2.1.4
Package:
Microsoft.Data.SqlClient v3.0.1
Package:
Microsoft.Data.SqlClient v3.1.0
Package:
Microsoft.Data.SqlClient v4.0.1
Package:
Microsoft.Data.SqlClient v4.1.0
Package:
Microsoft.Data.SqlClient v5.0.0
Package:
Microsoft.Data.SqlClient v5.1.0
Package:
Microsoft.Data.SqlClient v5.2.0

Gets or sets the minimum time, in seconds, for the connection to live in the connection pool before being destroyed.

public:
 property int LoadBalanceTimeout { int get(); void set(int value); };
public int LoadBalanceTimeout { get; set; }
member this.LoadBalanceTimeout : int with get, set
Public Property LoadBalanceTimeout As Integer

Property Value

Int32

The value of the LoadBalanceTimeout property, or 0 if none has been supplied.

Remarks

This property corresponds to the "Load Balance Timeout" and "connection lifetime" keys within the connection string.

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online.

A value of zero (0) causes pooled connections to have the maximum connection timeout.

Applies to