WebSocketOptions.KeepAliveInterval Property

  • Reference

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.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.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.1.24452.1
Source:
WebSocketOptions.cs
Source:
WebSocketOptions.cs

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

TimeSpan

Remarks

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

Applies to