redb.Route.WebSocket
2.0.2
Prefix Reserved
dotnet add package redb.Route.WebSocket --version 2.0.2
NuGet\Install-Package redb.Route.WebSocket -Version 2.0.2
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="redb.Route.WebSocket" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="redb.Route.WebSocket" Version="2.0.2" />
<PackageReference Include="redb.Route.WebSocket" />
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 redb.Route.WebSocket --version 2.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: redb.Route.WebSocket, 2.0.2"
#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 redb.Route.WebSocket@2.0.2
#: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=redb.Route.WebSocket&version=2.0.2
#tool nuget:?package=redb.Route.WebSocket&version=2.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
redb.Route.WebSocket
WebSocket transport for redb.Route. ClientWebSocket producer and Kestrel-based WebSocket server consumer with text/binary frames, ping/pong, reconnect, and subprotocol support.
Installation
dotnet add package redb.Route.WebSocket
Usage
Fluent DSL
using redb.Route.WebSocket.Fluent;
// WebSocket server (consumer)
From(Ws.Listen("0.0.0.0:8080/ws")
.MaxConnections(500)
.InOut())
.Process(async (e, ct) =>
{
var msg = e.Message.GetBody<string>();
e.Message.SetBody($"Echo: {msg}");
});
// WebSocket client (producer)
From("direct://push")
.To(Ws.Connect("wss://stream.example.com/feed")
.SubProtocol("json")
.ConnectTimeout(5000)
.Reconnect(intervalMs: 3000, maxAttempts: 10));
// Binary mode
From(Ws.Listen("0.0.0.0:8080/binary")
.Binary()
.ReceiveBufferSize(65536))
.To("direct://binary-handler");
// TLS
From(Ws.Listen("0.0.0.0:8443/secure")
.Ssl()
.SslCertPath("/certs/server.pfx")
.SslCertPassword("password"))
.To("direct://secure-handler");
Fluent Builder API
| Category | Methods |
|---|---|
| Server | Ws.Listen(hostPortPath), .MaxConnections(), .InOut() |
| Client | Ws.Connect(hostPortPath), .ConnectTimeout(), .Reconnect(interval, max) |
| Framing | .Binary(), .Encoding(), .SubProtocol() |
| Socket | .ReceiveBufferSize(), .SendBufferSize(), .KeepAliveInterval() |
| TLS | .Ssl(), .SslCertPath(), .SslCertPassword() |
Schemes
Both ws and wss schemes are supported for plain and TLS connections.
Part of
redb.Route — ESB & EIP Framework for .NET
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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.
-
net10.0
- redb.Route (>= 2.0.2)
-
net8.0
- redb.Route (>= 2.0.2)
-
net9.0
- redb.Route (>= 2.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.