Skip to content

Update SignalR docs #1789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremydmiller merged 2 commits into from
Oct 29, 2025
Merged

Update SignalR docs #1789

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6f2b6c
Added note about sending and recieving as strings
LodewijkSioen Oct 28, 2025
6ba86ed
Updated links to be version agnostic
LodewijkSioen Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/guide/messaging/transports/signalr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ builder.UseWolverine(opts =>
## Interacting with the Server from the Browser

It's not mandatory, but in developing and dogfooding the Wolverine.SignalR transport, we've found it helpful to use
the actual [signalr Javascript library](https://learn.microsoft.com/en-us/aspnet/core/signalr/javascript-client?view=aspnetcore-9.0&tabs=visual-studio) and
the actual [signalr Javascript library](https://learn.microsoft.com/en-us/aspnet/core/signalr/javascript-client) and
our sample SignalR application uses that library for the browser to server communication.

```js
Expand Down Expand Up @@ -253,6 +253,8 @@ document.getElementById("sendButton").addEventListener("click", function (event)

Note that the method `ReceiveMessage` is hard coded into the `WolverineHub` service.

Also note that messages are sent and recieved as raw json strings. You need to `JSON.parse` incoming messages and `JSON.stringify` outgoing messages yourself.

Our vision for this usage is that you probably integrate directly with a client side state tracking tool like [Pinia](https://pinia.vuejs.org/)
(how we're using the SignalR transport to build "CritterWatch").

Expand Down Expand Up @@ -320,7 +322,7 @@ In the next section we'll learn a bit more about working with SignalR groups.

## SignalR Groups

One of the powerful features of SignalR is being able to work with [groups of connections](https://learn.microsoft.com/en-us/aspnet/signalr/overview/guide-to-the-api/working-with-groups).
One of the powerful features of SignalR is being able to work with [groups of connections](https://learn.microsoft.com/en-us/aspnet/core/signalr/groups).
The SignalR transport currently has some simple support for managing and publishing to groups. Let's say you have
these web socket messages in your system:

Expand Down Expand Up @@ -379,7 +381,7 @@ type of integration testing through SignalR.
:::

Wolverine.SignalR is actually two transports in one library! There is also a full fledged messaging transport built
around the [.NET SignalR client](https://learn.microsoft.com/en-us/aspnet/core/signalr/dotnet-client?view=aspnetcore-9.0&tabs=visual-studio) that we've used extensively for test automation, but could technically be used as
around the [.NET SignalR client](https://learn.microsoft.com/en-us/aspnet/core/signalr/dotnet-client) that we've used extensively for test automation, but could technically be used as
a "real" messaging transport. The SignalR Client transport was built specifically to enable end to end testing against
a Wolverine server that hosts SignalR itself. The SignalR Client transport will use the same CloudEvents mechanism to
send and receive messages from the main Wolverine SignalR transport and is 100% compatible.
Expand Down
Loading