👁 Image
Websocket.Client 5.5.0

👁 Logo

Websocket .NET client

👁 NuGet version
👁 Nuget downloads
👁 CI build

This is a wrapper over native C# class ClientWebSocket with built-in reconnection and error handling.

Releases and breaking changes

License:

MIT

Features

• installation via NuGet (Websocket.Client)
• targeting .NET Standard 2.0, .NET Standard 2.1, .NET 6, .NET 7, .NET 8, .NET 9, and .NET 10
• full .NET Framework support through the .NET Standard 2.0 asset; the included framework sample targets .NET Framework 4.7.2 on Windows
• reactive extensions (Rx.NET)
• integrated logging abstraction (Microsoft.Extensions.Logging)
• using Channels for high performance sending queue
• allocation-conscious receive and send paths using reusable buffers and pooled text encoding

Performance

Websocket.Client is designed for long-running websocket consumers where per-message allocation and reconnect behavior matter:

• incoming messages are accumulated in a reusable pooled receive buffer
• text messages are decoded directly from the received bytes
• outgoing text messages are encoded into rented ArrayPool<byte> buffers
• the sending queue uses System.Threading.Channels with a single reader
• public observable wrappers are cached to avoid per-access wrapper allocations
• disabled trace logging is guarded to avoid hot-path log argument allocations
• queued text send requests use an internal value-type envelope to avoid a per-message wrapper allocation
• multi-segment binary sends complete on the final real segment without an extra empty websocket frame

Representative BenchmarkDotNet results show meaningful improvements on typical small and medium messages:

• 128 B text receive path: 264.17 ns / 560 B to 36.26 ns / 280 B
• 4 KB text receive path: 784.50 ns / 8496 B to 485.90 ns / 8216 B
• 1024 char text send encoding: 102.36 ns / 1048 B to 71.05 ns / 0 B
• 8192 char text send encoding: 738.40 ns / 8216 B to 419.79 ns / 0 B
• disabled trace logging: 28.72 ns / 64 B to approximately 0 ns / 0 B
• queued text request envelope: 31.54 ns / 24 B to 29.65 ns / 0 B
• stream-backed binary ResponseMessage.ToString() at 32 KB: 1.149 us / 32872 B to 44.60 ns / 104 B
• .NET Framework 4.8.1 client receive path, via the netstandard2.0 asset: 1000 x 1024 B text messages in 1.062 ms / 2312.21 KB

For very large text messages, the resulting string allocation dominates the receive cost, so the library focuses on avoiding unnecessary intermediate allocations and avoiding retention of oversized receive buffers after traffic spikes.

See the folder for the BenchmarkDotNet project, commands, and full result tables.

Usage

var exitEvent = new ManualResetEvent(false);
var url = new Uri("wss://xxx");

using (var client = new WebsocketClient(url))
{
 client.ReconnectTimeout = TimeSpan.FromSeconds(30);
 client.ReconnectionHappened.Subscribe(info =>
 Log.Information($"Reconnection happened, type: {info.Type}"));

 client.MessageReceived.Subscribe(msg => Log.Information($"Message received: {msg}"));
 client.Start();

 Task.Run(() => client.Send("{ message }"));

 exitEvent.WaitOne();
}

More usage examples:

• integration tests ()
• console sample ()
• .net framework sample ()
• blazor sample ()

Pull Requests are welcome!

Advanced configuration

To set some advanced configurations, which are available on the native ClientWebSocket class, you have to provide the factory method as a second parameter to WebsocketClient. That factory method will be called on every reconnection to get a new instance of the ClientWebSocket.

var factory = new Func<ClientWebSocket>(() => new ClientWebSocket
{
 Options =
 {
 KeepAliveInterval = TimeSpan.FromSeconds(5),
 Proxy = ...
 ClientCertificates = ...
 }
});

var client = new WebsocketClient(url, factory);
client.Start();

Also, you can access the current native class via client.NativeClient. But use it with caution, on every reconnection there will be a new instance.

Change URL on the fly

It is possible to change the remote server URL dynamically. Example:

client.Url = new Uri("wss://my_new_url");;
await client.Reconnect();

Reconnecting

A built-in reconnection invokes after 1 minute (default) of not receiving any messages from the server. It is possible to configure that timeout via communicator.ReconnectTimeout. In addition, a stream ReconnectionHappened sends information about the type of reconnection. However, if you are subscribed to low-rate channels, you will likely encounter that timeout - higher it to a few minutes or implement ping-pong interaction on your own every few seconds.

In the case of a remote server outage, there is a built-in functionality that slows down reconnection requests (could be configured via client.ErrorReconnectTimeout, the default is 1 minute).

Usually, websocket servers do not keep a persistent connection between reconnections. Every new connection creates a new session. Because of that, you most likely need to resubscribe to channels/groups/topics inside ReconnectionHappened stream.

client.ReconnectionHappened.Subscribe(info => {
 client.Send("{type: subscribe, topic: xyz}")
});

Multi-threading

Observables from Reactive Extensions are single threaded by default. It means that your code inside subscriptions is called synchronously and as soon as the message comes from websocket API. It brings a great advantage of not to worry about synchronization, but if your code takes a longer time to execute it will block the receiving method, buffer the messages and may end up losing messages. For that reason consider to handle messages on the other thread and unblock receiving thread as soon as possible. I've prepared a few examples for you:

Default behavior

Every subscription code is called on a main websocket thread. Every subscription is synchronized together. No parallel execution. It will block the receiving thread.

client
 .MessageReceived
 .Where(msg => msg.Text != null)
 .Where(msg => msg.Text.StartsWith("{"))
 .Subscribe(obj => { code1 });

client
 .MessageReceived
 .Where(msg => msg.Text != null)
 .Where(msg => msg.Text.StartsWith("["))
 .Subscribe(arr => { code2 });

// 'code1' and 'code2' are called in a correct order, according to websocket flow
// ----- code1 ----- code1 ----- ----- code1
// ----- ----- code2 ----- code2 code2 -----

Parallel subscriptions

Every single subscription code is called on a separate thread. Every single subscription is synchronized, but different subscriptions are called in parallel.

client
 .MessageReceived
 .Where(msg => msg.Text != null)
 .Where(msg => msg.Text.StartsWith("{"))
 .ObserveOn(TaskPoolScheduler.Default)
 .Subscribe(obj => { code1 });

client
 .MessageReceived
 .Where(msg => msg.Text != null)
 .Where(msg => msg.Text.StartsWith("["))
 .ObserveOn(TaskPoolScheduler.Default)
 .Subscribe(arr => { code2 });

// 'code1' and 'code2' are called in parallel, do not follow websocket flow
// ----- code1 ----- code1 ----- code1 -----
// ----- code2 code2 ----- code2 code2 code2

Parallel subscriptions with synchronization

In case you want to run your subscription code on the separate thread but still want to follow websocket flow through every subscription, use synchronization with gates:

private static readonly object GATE1 = new object();
client
 .MessageReceived
 .Where(msg => msg.Text != null)
 .Where(msg => msg.Text.StartsWith("{"))
 .ObserveOn(TaskPoolScheduler.Default)
 .Synchronize(GATE1)
 .Subscribe(obj => { code1 });

client
 .MessageReceived
 .Where(msg => msg.Text != null)
 .Where(msg => msg.Text.StartsWith("["))
 .ObserveOn(TaskPoolScheduler.Default)
 .Synchronize(GATE1)
 .Subscribe(arr => { code2 });

// 'code1' and 'code2' are called concurrently and follow websocket flow
// ----- code1 ----- code1 ----- ----- code1
// ----- ----- code2 ----- code2 code2 ----

Async/Await integration

Using async/await in your subscribe methods is a bit tricky. Subscribe from Rx.NET doesn't await tasks, so it won't block stream execution and cause sometimes undesired concurrency. For example:

client
 .MessageReceived
 .Subscribe(async msg => {
 // do smth 1
 await Task.Delay(5000); // waits 5 sec, could be HTTP call or something else
 // do smth 2
 });

That await Task.Delay won't block stream and subscribe method will be called multiple times concurrently. If you want to buffer messages and process them one-by-one, then use this:

client
 .MessageReceived
 .Select(msg => Observable.FromAsync(async () => {
 // do smth 1
 await Task.Delay(5000); // waits 5 sec, could be HTTP call or something else
 // do smth 2
 }))
 .Concat() // executes sequentially
 .Subscribe();

If you want to process them concurrently (avoid synchronization), then use this

client
 .MessageReceived
 .Select(msg => Observable.FromAsync(async () => {
 // do smth 1
 await Task.Delay(5000); // waits 5 sec, could be HTTP call or something else
 // do smth 2
 }))
 .Merge() // executes concurrently
 // .Merge(4) you can limit concurrency with a parameter
 // .Merge(1) is same as .Concat() (sequentially)
 // .Merge(0) is invalid (throws exception)
 .Subscribe();

More info on Github issue.

Don't worry about websocket connection, those sequential execution via .Concat() or .Merge(1) has no effect on receiving messages. It won't affect receiving thread, only buffers messages inside MessageReceived stream.

But beware of producer-consumer problem when the consumer will be too slow. Here is a StackOverflow issue with an example how to ignore/discard buffered messages and always process only the last one.

Available for help

I do consulting, please don't hesitate to contact me if you need a paid help
(web, nostr, )