Share via

ConnectionPolicy.OpenTcpConnectionTimeout Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents.Client
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

(Direct/TCP) Controls the amount of time allowed for trying to establish a connection.

public TimeSpan? OpenTcpConnectionTimeout { get; set; }
member this.OpenTcpConnectionTimeout : Nullable<TimeSpan> with get, set
Public Property OpenTcpConnectionTimeout As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

The default timeout is 5 seconds. Recommended values are greater than or equal to 5 seconds.

Remarks

When the time elapses, the attempt is cancelled and an error is returned. Longer timeouts will delay retries and failures.

Applies to