Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devlooped/websocketpipe
System.IO.Pipelines API adapter for System.Net.WebSockets
https://github.com/devlooped/websocketpipe
csharp dotnet networking pipelines websocket websockets
Last synced: 13 days ago
JSON representation
System.IO.Pipelines API adapter for System.Net.WebSockets
- Host: GitHub
- URL: https://github.com/devlooped/websocketpipe
- Owner: devlooped
- License: mit
- Created: 2021-09-20T18:03:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T00:45:21.000Z (19 days ago)
- Last Synced: 2024-11-04T04:34:58.490Z (16 days ago)
- Topics: csharp, dotnet, networking, pipelines, websocket, websockets
- Language: C#
- Homepage: https://clarius.org/WebSocketPipe
- Size: 102 KB
- Stars: 25
- Watchers: 6
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license.txt
- Security: security.md
Awesome Lists containing this project
README
 WebSocketPipe
============
High-performance System.IO.Pipelines API adapter for System.Net.WebSockets
[](https://www.nuget.org/packages/WebSocketPipe)
[](https://www.nuget.org/packages/WebSocketPipe)
[](https://github.com/devlooped/WebSocketPipe/blob/main/license.txt)
[](https://github.com/devlooped/WebSocketPipe/actions)
# Usage
```csharp
using Devlooped.Net;
var client = new ClientWebSocket();
await client.ConnectAsync(serverUri, CancellationToken.None);
using IWebSocketPipe pipe = WebSocketPipe.Create(client, closeWhenCompleted: true);
// Start the pipe before hooking up the processing
var run = pipe.RunAsync();
```
The `IWebSocketPipe` interface extends [IDuplexPipe](https://docs.microsoft.com/en-us/dotnet/api/system.io.pipelines.iduplexpipe?view=dotnet-plat-ext-5.0),
exposing `Input` and `Output` properties that can be used to
read incoming messages and write outgoing ones.
For example, to read incoming data and write it to the console,
we could write the following code:
```csharp
await ReadIncoming(pipe.Input);
async Task ReadIncoming(PipeReader reader)
{
while (await reader.ReadAsync() is var result && !result.IsCompleted)
{
Console.WriteLine($"Received: {Encoding.UTF8.GetString(result.Buffer)}");
reader.AdvanceTo(result.Buffer.End);
}
Console.WriteLine($"Done reading.");
}
```
Similarly, to write to the underlying websocket the input
entered in the console, we use code like the following:
```csharp
await SendOutgoing(pipe.Output);
async Task SendOutgoing(PipeWriter writer)
{
while (Console.ReadLine() is var line && line?.Length > 0)
{
Encoding.UTF8.GetBytes(line, writer);
}
await writer.CompleteAsync();
Console.WriteLine($"Done writing.");
}
```
If we wanted to simultaneously read and write and wait for
completion of both operations, we could just wait for both
tasks:
```csharp
// Wait for completion of processing code
await Task.WhenAny(
ReadIncoming(pipe.Input),
SendOutgoing(pipe.Output));
```
Note that completing the `PipeWriter` automatically causes the
reader to reveive a completed result and exit the loop. In addition,
the overall `IWebSocketPipe.RunAsync` task will also run to completion.
The `IWebSocketPipe` takes care of gracefully closing the connection
when the input or output are completed, if `closeWhenCompleted` is set
to true when creating it.
Alternatively, it's also possible to complete the entire pipe explicitly,
while setting an optional socket close status and status description for
the server to act on:
```csharp
await pipe.CompleteAsync(WebSocketCloseStatus.NormalClosure, "Done processing");
```
Specifying a close status will always close the underlying socket.
The `WebSocketPipe` can also be used on the server. The following example is basically
taken from the documentation on [WebSockets in ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/websockets?view=aspnetcore-5.0#configure-the-middleware)
and adapted to use a `WebSocketPipe` to echo messages to the client:
```csharp
app.Use(async (context, next) =>
{
if (context.Request.Path == "/ws")
{
if (context.WebSockets.IsWebSocketRequest)
{
using var websocket = await context.WebSockets.AcceptWebSocketAsync();
using var pipe = WebSocketPipe.Create(websocket, true);
await Task.WhenAll(Echo(pipe), pipe.RunAsync(context.RequestAborted));
}
else
{
context.Response.StatusCode = (int) HttpStatusCode.BadRequest;
}
}
else
{
await next();
}
});
```
The sample `Echo` method is simply:
```csharp
async Task Echo(IDuplexPipe pipe)
{
while (await pipe.Input.ReadAsync() is var result && !result.IsCompleted)
{
// Just assume we get a single-segment entry, for simplicity
await pipe.Output.WriteAsync(result.Buffer.First);
pipe.Input.AdvanceTo(result.Buffer.End);
}
}
```
# Dogfooding
[](https://pkg.kzu.io/index.json)
[](https://github.com/devlooped/WebSocketPipe/actions)
We also produce CI packages from branches and pull requests so you can dogfood builds as quickly as they are produced.
The CI feed is `https://pkg.kzu.io/index.json`.
The versioning scheme for packages is:
- PR builds: *42.42.42-pr*`[NUMBER]`
- Branch builds: *42.42.42-*`[BRANCH]`.`[COMMITS]`
# Sponsors
[](https://github.com/clarius)
[](https://github.com/KirillOsenkov)
[](https://github.com/MFB-Technologies-Inc)
[](https://github.com/decriptor)
[](https://github.com/torutek-gh)
[](https://github.com/drivenet)
[](https://github.com/AshleyMedway)
[](https://github.com/Keflon)
[](https://github.com/tbolon)
[](https://github.com/kfrancis)
[](https://github.com/twenzel)
[](https://github.com/Giorgi)
[](https://github.com/unoplatform)
[](https://github.com/dansiegel)
[](https://github.com/rbnswartz)
[](https://github.com/jfoshee)
[](https://github.com/Mrxx99)
[](https://github.com/eajhnsn1)
[](https://github.com/IxTechnologies)
[](https://github.com/davidjenni)
[](https://github.com/Jonathan-Hickey)
[](https://github.com/okyrylchuk)
[](https://github.com/akunzai)
[](https://github.com/jakobt)
[](https://github.com/seanalexander)
[](https://github.com/tinohager)
[](https://github.com/ploeh)
[](https://github.com/KenBonny)
[](https://github.com/SimonCropp)
[](https://github.com/agileworks-eu)
[](https://github.com/sorahex)
[](https://github.com/arsdragonfly)
[](https://github.com/vezel-dev)
[](https://github.com/ChilliCream)
[](https://github.com/4OTC)
[](https://github.com/sponsors/devlooped)
[Learn more about GitHub Sponsors](https://github.com/sponsors)