Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

WebSocketOptions.KeepAliveInterval Property

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.WebSockets.Server.dll
Assembly:
Microsoft.AspNetCore.WebSockets.dll
Package:
Microsoft.AspNetCore.WebSockets.Server v0.1.0
Package:
Microsoft.AspNetCore.WebSockets v1.0.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.WebSockets v2.0.0
Package:
Microsoft.AspNetCore.WebSockets v2.1.0
Package:
Microsoft.AspNetCore.WebSockets v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
WebSocketOptions.cs
Source:
WebSocketOptions.cs

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 interval to send keep-alive frames. This is a heart-beat that keeps the connection alive. The default is two minutes.

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

Property Value

Remarks

May be either a Ping or a Pong frame, depending on if KeepAliveTimeout is set.

Applies to

Feedback

Was this page helpful?