VoDA.WebSockets 8.2.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package VoDA.WebSockets --version 8.2.0

NuGet\Install-Package VoDA.WebSockets -Version 8.2.0

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="VoDA.WebSockets" Version="8.2.0" />

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

paket add VoDA.WebSockets --version 8.2.0

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

#r "nuget: VoDA.WebSockets, 8.2.0"

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

// Install VoDA.WebSockets as a Cake Addin
#addin nuget:?package=VoDA.WebSockets&version=8.2.0

// Install VoDA.WebSockets as a Cake Tool
#tool nuget:?package=VoDA.WebSockets&version=8.2.0

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

Description

This library provides an easy way to use WebSockets in your ASP.NET project. The usage method is similar to ASP.NET MVC controllers, but for WebSocket.

Quick Start

Install the NuGet package into your project.
Create a new class that inherits from BaseWebSocketController.
- You can add a RouteAttribute attribute to your class for custom routing.
Add methods to your class that will handle WebSocket events.
- You can add a WebSocketPathAttribute attribute to your method for custom routing.
- You can add a WebSocketCyclicAttribute attribute to your method to make it cyclic (see example).

Example

[Route("/ws")]
public class MyWebSocketController : BaseWebSocketController
{
    [WebSocketPath("/")]
    public async Task OnOpenAsync()
    {
        await Client.SendAsync("Hello!");
    }

    [WebSocketCyclic]
    [WebSocketPath("echo")]
    public async Task OnMessageAsync(string message)
    {
        await Client.SendAsync(message);
    }

    [WebSocketPath("{id}")]
    public async Task OnCyclicAsync(string id)
    {
        await Client.SendAsync("Hello " + id);
        await Client.SendAsync("Bye " + id);
    }
}

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

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.Mvc (>= 2.2.0)
- Microsoft.AspNetCore.WebSockets (>= 2.2.1)
- Microsoft.Extensions.DependencyInjection (>= 7.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 7.0.0)
- Microsoft.Extensions.Options (>= 7.0.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.