From 23b135554824eef85817e02f0f5eeba8fa8650ea Mon Sep 17 00:00:00 2001 From: Wade Pickett Date: Mon, 17 Jul 2023 10:40:51 -0700 Subject: [PATCH] SignalR Config: Remove incorrect ping info (#29814) --- aspnetcore/signalr/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aspnetcore/signalr/configuration.md b/aspnetcore/signalr/configuration.md index dcc3ca77b6..6d1c1e3443 100644 --- a/aspnetcore/signalr/configuration.md +++ b/aspnetcore/signalr/configuration.md @@ -280,7 +280,7 @@ Additional options for configuring timeout and keep-alive behavior: | ------ | ------------- | ----------- | | `WithServerTimeout` | 30 seconds (30,000 milliseconds) | Timeout for server activity and is set directly on . If the server hasn't sent a message in this interval, the client considers the server disconnected and triggers the `Closed` event (`onclose` in JavaScript). This value must be large enough for a ping message to be sent from the server **and** received by the client within the timeout interval. The recommended value is a number at least double the server's keep-alive interval (`WithKeepAliveInterval`) value to allow time for pings to arrive. | | `HandshakeTimeout` | 15 seconds | Timeout for initial server handshake and is available on the `HubConnection` object itself. If the server doesn't send a handshake response in this interval, the client cancels the handshake and triggers the `Closed` event (`onclose` in JavaScript). This is an advanced setting that should only be modified if handshake timeout errors are occurring due to severe network latency. For more detail on the handshake process, see the [SignalR Hub Protocol Specification](https://github.com/aspnet/SignalR/blob/master/specs/HubProtocol.md). | -| `WithKeepAliveInterval` | 15 seconds | Determines the interval at which the client sends ping messages and is set directly on . This setting allows the server to detect hard disconnects, such as when a client unplugs their computer from the network. Sending any message from the client resets the timer to the start of the interval. If the client hasn't sent a message in the `ClientTimeoutInterval` set on the server, the server considers the client disconnected. The ping occurs at most as often as the server pings. If the server pings every five seconds, assigning a value lower than `5000` (5 seconds) pings every five seconds. The default value is 15 seconds. The keep-alive interval should be less than or equal to half the value assigned to the server timeout (`WithServerTimeout`). | +| `WithKeepAliveInterval` | 15 seconds | Determines the interval at which the client sends ping messages and is set directly on . This setting allows the server to detect hard disconnects, such as when a client unplugs their computer from the network. Sending any message from the client resets the timer to the start of the interval. If the client hasn't sent a message in the `ClientTimeoutInterval` set on the server, the server considers the client disconnected. | In the .NET Client, timeout values are specified as `TimeSpan` values.