Cyaim.WebSocketServer 1.7.8

.NET 6.0 .NET Standard 2.1

dotnet add package Cyaim.WebSocketServer --version 1.7.8

NuGet\Install-Package Cyaim.WebSocketServer -Version 1.7.8

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="Cyaim.WebSocketServer" Version="1.7.8" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Cyaim.WebSocketServer" Version="1.7.8" />
                    

                            Directory.Packages.props

<PackageReference Include="Cyaim.WebSocketServer" />
                    

                            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 Cyaim.WebSocketServer --version 1.7.8

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Cyaim.WebSocketServer, 1.7.8"

#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.

#addin nuget:?package=Cyaim.WebSocketServer&version=1.7.8
                    

                            Install as a Cake Addin

#tool nuget:?package=Cyaim.WebSocketServer&version=1.7.8
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

WebSocketServer

996ICU	Version	NuGet	Build	Code Size	License

WebSocketServer is lightweight and high performance WebSocket library.Support route, full duplex communication.

QuickStart

Install library

Install-Package Cyaim.WebSocketServer 2. Configure middleware

Configure websocket route

services.ConfigureWebSocketRoute(x =>
{
    //Define channels
    x.WebSocketChannels = new Dictionary<string, WebSocketRouteOption.WebSocketChannelHandler>()
    {
        { "/ws",new MvcChannelHandler(4*1024).ConnectionEntry}
    };
    x.ApplicationServiceCollection = services;
});

Configure middleware

var webSocketOptions = new WebSocketOptions()
{
    KeepAliveInterval = TimeSpan.FromSeconds(120),

    // This configuration has been deprecated
    ReceiveBufferSize = 4 * 1024
};
app.UseWebSockets(webSocketOptions);
app.UseWebSocketServer();

Minimal API can be use

builder.Services.ConfigureWebSocketRoute(x =>
{
    //Define channels
    x.WebSocketChannels = new Dictionary<string, WebSocketRouteOption.WebSocketChannelHandler>()
    {
        { "/ws",new MvcChannelHandler(4*1024).ConnectionEntry}
    };
    x.ApplicationServiceCollection = builder.Services;
});

var webSocketOptions = new WebSocketOptions()
{
    KeepAliveInterval = TimeSpan.FromSeconds(120),
};
app.UseWebSockets(webSocketOptions);
app.UseWebSocketServer();

Mark WebSocket Endpoints
- Go to Controller → Action
- Add attribute [WebSocket]

[WebSocket] → "method" parameter ignore case

Example Code:

// mark WebSocket 
[WebSocket()]
[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
    var rng = new Random();
    return Enumerable.Range(1, 2).Select(index => new WeatherForecast
    {
         Date = DateTime.Now.AddDays(index),
         TemperatureC = rng.Next(-20, 55),
         Summary = Summaries[rng.Next(Summaries.Length)]
    }).ToArray();
}

Request and Response

Scheme namespace 👇
Request Cyaim.WebSocketServer.Infrastructure.Handlers.MvcRequestScheme
Response Cyaim.WebSocketServer.Infrastructure.Handlers.MvcResponseScheme

Request target ignore case

Request scheme

1. Nonparametric method request

{
	"target": "WeatherForecast.Get",
	"body": {}
}

This request will be located at "WeatherForecastController" → "Get" Method.

Response to this request

{
	"Target": "WeatherForecast.Get"
	"Status": 0,
	"Msg": null,
	"RequestTime": 637395762382112345,
	"CompleteTime": 637395762382134526,
	"Body": [{
		"Date": "2020-10-30T13:50:38.2133285+08:00",
		"TemperatureC": 43,
		"TemperatureF": 109,
		"Summary": "Scorching"
	}, {
		"Date": "2020-10-31T13:50:38.213337+08:00",
		"TemperatureC": 1,
		"TemperatureF": 33,
		"Summary": "Chilly"
	}]
}

Forward invoke method return content will write MvcResponseScheme.Body.

2. Request with parameters

Example Code:

Change method code to:

[WebSocket]
[HttpGet]
public IEnumerable<WeatherForecast> Get(Test a)
{
    var rng = new Random();
    return Enumerable.Range(1, 2).Select(index => new WeatherForecast
    {
         TemperatureC = a.PreTemperatureC + rng.Next(-20, 55),
         Summary = a.PreSummary + Summaries[rng.Next(Summaries.Length)]
    }).ToArray();
}

Define parameter class

public class Test
{
    public string PreSummary { get; set; }
    public int PreTemperatureC { get; set; }
}

Request parameter

{
	"target": "WeatherForecast.Get",
	"body": {
	    "PreSummary":"Cyaim_",
	    "PreTemperatureC":233
	}
}

Request body will write invoke method parameter.

Response to this request

{
	"Target": "WeatherForecast.Get"
	"Status": 0,
	"Msg": null,
	"RequestTime": 0,
	"CompleteTime": 637395922139434966,
	"Body": [{
		"Date": "0001-01-01T00:00:00",
		"TemperatureC": 282,
		"TemperatureF": 539,
		"Summary": "Cyaim_Warm"
	}, {
		"Date": "0001-01-01T00:00:00",
		"TemperatureC": 285,
		"TemperatureF": 544,
		"Summary": "Cyaim_Sweltering"
	}]
}

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. 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 was computed. 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 was computed. 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.
.NET Core	netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.1 is compatible.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.1
- Microsoft.AspNetCore.Hosting.Server.Abstractions (>= 2.1.1)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.1.1)
- Microsoft.CSharp (>= 4.7.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
- System.Text.Json (>= 8.0.5)
- System.Threading.Channels (>= 8.0.0)
net6.0
- No dependencies.
net7.0
- No dependencies.
net8.0
- No dependencies.

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.7.8	1,022	10/20/2024
1.7.7	140	10/16/2024
1.7.6	108	10/16/2024
1.7.5	107	10/14/2024
1.7.4	117	10/14/2024
1.7.3	496	8/22/2024
1.7.2	167	8/16/2024
1.7.1	140	5/31/2024
1.7.0	147	5/30/2024
1.6.4	126	5/21/2024
1.6.3	123	5/16/2024
1.6.2	128	5/15/2024
1.6.1	138	5/15/2024
1.6.0	367	11/25/2022
1.5.9	364	11/20/2022
1.5.8	525	12/30/2020
1.5.7	480	12/25/2020
1.5.6	433	12/3/2020
1.5.5	427	11/12/2020
1.5.4	470	11/12/2020
1.5.3	468	11/11/2020
1.5.2	465	11/10/2020
1.5.1	500	10/30/2020
1.5.0	503	10/30/2020
1.0.0	456	10/29/2020

fix: When fixing a Task type with no return value as the target endpoint, an exception will be thrown.
perf: Exception information will be displayed internally.

Cyaim.WebSocketServer 1.7.8

WebSocketServer

QuickStart

Request and Response

1. Nonparametric method request

2. Request with parameters

.NETStandard 2.1

net6.0

net7.0

net8.0

NuGet packages

GitHub repositories