SocketsHttpHandler.KeepAlivePingTimeout Property

Definition

Namespace:

System.Net.Http

Assembly:

System.Net.Http.dll

Source:

SocketsHttpHandler.cs

Gets or sets the keep alive ping timeout.

public:
 property TimeSpan KeepAlivePingTimeout { TimeSpan get(); void set(TimeSpan value); };

public TimeSpan KeepAlivePingTimeout { get; set; }

member this.KeepAlivePingTimeout : TimeSpan with get, set

Public Property KeepAlivePingTimeout As TimeSpan

Property Value

TimeSpan

The keep alive ping timeout. Defaults to 20 seconds.

Exceptions

ArgumentOutOfRangeException

The provided value is smaller than 1 second and is not InfiniteTimeSpan

-or-

The provided value is greater than MaxValue milliseconds.

InvalidOperationException

An operation has already been started on the current instance.

ObjectDisposedException

The current instance has been disposed.

Remarks

Keep alive pings are sent when a period of inactivity exceeds the configured KeepAlivePingDelay value. The client will close the connection if it doesn't receive any frames within the timeout.

Timeout must be greater than or equal to 1 second. Set to InfiniteTimeSpan to disable the keep alive ping timeout.