Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luca-schlecker/swebsocket
A Simple and Plain WebSocket Library for C#
https://github.com/luca-schlecker/swebsocket
client csharp easy-to-use nuget server websocket websocket-client websocket-server
Last synced: 7 days ago
JSON representation
A Simple and Plain WebSocket Library for C#
- Host: GitHub
- URL: https://github.com/luca-schlecker/swebsocket
- Owner: luca-schlecker
- License: mit
- Created: 2024-03-15T02:01:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-20T19:04:25.000Z (6 months ago)
- Last Synced: 2024-10-16T11:22:15.404Z (22 days ago)
- Topics: client, csharp, easy-to-use, nuget, server, websocket, websocket-client, websocket-server
- Language: C#
- Homepage:
- Size: 91.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
SwebSocket
A handwritten, easy to use WebSocket Library that aims to:
- Follow [RFC6455](https://datatracker.ietf.org/doc/html/rfc6455)
- Be easy to use
- Allow [Client](#client) and [Server](#server) use-cases
- Integrate [Secure Connections](#secure-connection)
- Be Portable (`netstandard2.1`)
## Disclaimer
> [!WARNING]
> This is a fun-project and may contain severe errors. You should probably not use this in production.
## Installation
This Library is on [NuGet](https://www.nuget.org/packages/SwebSocket) and can thus be installed in many ways, including but not limited to:
- [Dotnet CLI](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-dotnet-cli)
- [Visual Studio NuGet Package Manager](https://learn.microsoft.com/nuget/consume-packages/install-use-packages-visual-studio)
- [NuGet for Unity](https://github.com/GlitchEnzo/NuGetForUnity)
There are more provided on the NuGet Page.
## Examples
### Client
#### Echo Client (Manual)
```cs
using SwebSocket;
var ws = WebSocket
.Connect()
.To("wss://echo.websocket.org/")
.Build();
// Discard first message
_ = ws.Receive();
while (true) {
var line = Console.ReadLine();
if (line == null) break;
ws.Send(line);
var answer = ws.Receive();
if (answer is TextMessage text)
Console.WriteLine($"Received: {text.Text}");
}
```
#### Echo Client (Background Poller)
```cs
using SwebSocket;
var ws = WebSocket
.Connect()
.To("wss://echo.websocket.org/")
.Build();
ws.OnMessage += (_, message) => {
if (message is TextMessage text)
Console.WriteLine($"Received: {text.Text}");
};
BackgroundMessagePoller.Poll(ws);
while (true) {
var line = Console.ReadLine();
if (line == null) break;
ws.Send(line);
}
```
> [!IMPORTANT]
> The `WebSocket.OnMessage` event will (by default) **not** be raised.
> You can raise it manually by calling `WebSocket.EmitMessage(Message)` or use a Poller which will call it under the hood.
### Server
#### Echo Server (Manual)
```cs
using SwebSocket;
var listener = new Listener(IPAddress.Any, 3000);
while (true) {
var ws = listener.Accept();
try {
while (true) {
var message = ws.Receive();
ws.Send(message);
}
}
catch { }
}
```
#### Echo Server (Blocking Poller)
```cs
using SwebSocket;
var listener = new Listener(IPAddress.Any, 3000);
while (true) {
var ws = listener.Accept();
ws.OnMessage += (_, m) => ws.Send(m);
new BlockingMessagePoller(ws).Poll();
}
```
### Secure Connection
#### Client
```cs
using SwebSocket;
var listener = new Listener(IPAddress.Any, 3000)
.UseSsl(SslOptions.NoSsl) // No Ssl
.UseSsl(SslOptions.ForServer(identity)); // X509Certificate2 as Identity
// ...
```
#### Server
```cs
using SwebSocket;
var ws = WebSocket
.Connect()
.To("wss://127.0.0.1/")
.UseSsl(SslOptions.ForClient(
"custom authority", // The name to validate the certificate against
caCertificates // X509Certificate2Collection
))
.Build();
// ...
```
## Related Projects
- [WebSocket-Sharp](https://github.com/sta/websocket-sharp)
- [System.Net.WebSockets](https://learn.microsoft.com/en-us/dotnet/api/system.net.websockets)
- [Fleck](https://github.com/statianzo/Fleck)
- [WatsonWebsocket](https://github.com/jchristn/WatsonWebsocket)