WebSocketAcceptContext.KeepAliveTimeout Property

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Features.dll

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.1.24452.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The time to wait for a Pong frame response after sending a Ping frame. If the time is exceeded the websocket will be aborted.

public TimeSpan? KeepAliveTimeout { get; set; }

member this.KeepAliveTimeout : Nullable<TimeSpan> with get, set

Public Property KeepAliveTimeout As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

Exceptions

ArgumentOutOfRangeException

TimeSpan is less than Zero.

Remarks

null means use the value from WebSocketOptions.KeepAliveTimeout. InfiniteTimeSpan and Zero are valid values and will disable the timeout.

Applies to

Share via