CustomPubSub.WebSocket 1.0.1

dotnet add package CustomPubSub.WebSocket --version 1.0.1
                    
NuGet\Install-Package CustomPubSub.WebSocket -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CustomPubSub.WebSocket" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CustomPubSub.WebSocket" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="CustomPubSub.WebSocket" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CustomPubSub.WebSocket --version 1.0.1
                    
#r "nuget: CustomPubSub.WebSocket, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CustomPubSub.WebSocket@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CustomPubSub.WebSocket&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=CustomPubSub.WebSocket&version=1.0.1
                    
Install as a Cake Tool

CustomPubSub.WebSocket

ASP.NET Core WebSocket middleware for room-based broadcasting, built on top of CustomPubSub.

Installation

dotnet add package CustomPubSub.WebSocket

Quick Start

using CustomPubSub.WebSocket;

builder.Services.AddCustomPubSubWebSocket();

var app = builder.Build();

app.UseCustomPubSubWebSocket();

WebSocket Endpoint

ws://localhost:<port>/ws/{room}
const socket = new WebSocket('ws://localhost:5000/ws/myroom');
socket.onmessage = (event) => console.log(event.data);

Options

services.AddCustomPubSubWebSocket(keepAliveInterval: TimeSpan.FromSeconds(60));

How It Works

  • Accepts WebSocket connections at /ws/{room}.
  • Tracks connected sockets per room in memory.
  • Subscribes to RabbitMQ for each active room via IMessageSubscriber.
  • Broadcasts incoming messages to all WebSocket clients in that room.
  • Reference-counts room subscriptions — shared across clients, cleaned up when the last client disconnects.

Requirements

Requires a CustomPubSub implementation (e.g. CustomPubSub.RabbitMq) to be registered.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 79 5/27/2026
1.0.0 97 5/27/2026