The SignalR Stream documentation is confusing

[mobiletonster]

Description

It feels like each section of the SignalR streaming is incomplete and confusing. It is difficult to understand how to pair the server and client sides together as each example isn't very explicit of whether it is the server or client side. This documentation needs to be drastically improved, PLEASE!

Switching between channels and IAsyncEnumerable doesn't help. I thinking breaking the article into two approaches, demonstrating IAsyncEnumerable examples for both Client to Server and Server to Client and a separate section for doing the same thing with Channels would be appropriate. It took me a long time to figure out that connection.StreamAsync() doesn't work from client to server event though there are no compiler warnings or errors even at runtime. Just doesn't work. You need to use connection.InvokeAsync() when streaming from client to server, but it seems you can us connection.StreamAsync() when streaming from server to client? Can you stream to multiple clients? Is there a StreamAllAsync()? or does that concept not make sense?

There should be a lot more here. I know Brady Gaster is a good author and teacher, so it is possible to improve these docs.

Page URL

https://learn.microsoft.com/en-us/aspnet/core/signalr/streaming?view=aspnetcore-9.0

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/signalr/streaming.md

Document ID

5f2f089e-310d-83a1-9c56-9cb441b9914a

Article author

@bradygaster

Related Issues