dotnet / dotnet/AspNetCore.Docs

Please document setting TransportSendTimeout for SignalR

Open
#30,364 3 comments 0 reactions 1 assignee Claimed by @wadepickett View on GitHub
seQUESTered SignalR Source - Docs.ms
Dominant language
C#
Stars
13.1k
Forks
24.6k
Avg merge
1d 3h
Merged PRs (30d)
97

Description

Hello,

Could you please document the TransportSendTimeout (default 10sec)

Also, could you document the possibility to pass a cancelation token in both the IClientProxy https://github.com/dotnet/aspnetcore/blob/6e49859a0762576dcb174dd7583cde78ddf73979/src/SignalR/server/Core/src/IClientProxy.cs#L23
AND
the strongly typed client as a last parameter :
https://github.com/dotnet/aspnetcore/blob/6e49859a0762576dcb174dd7583cde78ddf73979/src/SignalR/server/Core/src/Internal/TypedClientBuilder.cs#L214

It seems that both will allow the message to timeout.
https://github.com/dotnet/aspnetcore/blob/6e49859a0762576dcb174dd7583cde78ddf73979/src/SignalR/common/Http.Connections/src/Internal/HttpConnectionContext.cs#L616
But there is a the difference between relying on a CancelationToken timeout and the TransportSendTimeout

It seems (to my understanding), that the use of a CancelationToken timeout will bubble the timout exception to the caller of the Client method, while simply relying on TransportSendTimeout will swallow the exception and simply log it

I'm _kind of_ looking for a confirmation of my understanding of this mecanism

Thank you

Thomas P.

---
#### Document Details

⚠ *Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.*

* ID: de8cdc99-48bb-3266-05bb-eda98f59f2e2
* Version Independent ID: 66d252c3-6300-7e28-9aa0-ef2ff66e7a76
* Content: [ASP.NET Core SignalR configuration](https://learn.microsoft.com/en-us/aspnet/core/signalr/configuration?view=aspnetcore-7.0&tabs=dotnet)
* Content Source: [aspnetcore/signalr/configuration.md](https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/signalr/configuration.md)
* Product: **aspnet-core**
* Technology: **aspnetcore-signalr**
* GitHub Login: @bradygaster
* Microsoft Alias: **bradyg**

---
[Associated WorkItem - 187723](https://dev.azure.com/msft-skilling/Content/_workitems/edit/187723)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.