WebSocketMiddlewareExtensions.UseWebSockets Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.WebSockets.Server.dll
Assembly:
Microsoft.AspNetCore.WebSockets.dll
Package:
Microsoft.AspNetCore.WebSockets.Server v0.1.0
Package:
Microsoft.AspNetCore.WebSockets v1.0.0
Package:
Microsoft.AspNetCore.WebSockets v2.0.0
Package:
Microsoft.AspNetCore.WebSockets v2.1.0
Package:
Microsoft.AspNetCore.WebSockets v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

UseWebSockets(IApplicationBuilder)

Adds the WebSocketMiddleware to the request pipeline.
UseWebSockets(IApplicationBuilder, WebSocketOptions)

Adds the WebSocketMiddleware to the request pipeline.

UseWebSockets(IApplicationBuilder)

Source:
WebSocketMiddlewareExtensions.cs

Adds the WebSocketMiddleware to the request pipeline.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::IApplicationBuilder ^ UseWebSockets(Microsoft::AspNetCore::Builder::IApplicationBuilder ^ app);
public static Microsoft.AspNetCore.Builder.IApplicationBuilder UseWebSockets (this Microsoft.AspNetCore.Builder.IApplicationBuilder app);
static member UseWebSockets : Microsoft.AspNetCore.Builder.IApplicationBuilder -> Microsoft.AspNetCore.Builder.IApplicationBuilder
<Extension()>
Public Function UseWebSockets (app As IApplicationBuilder) As IApplicationBuilder

Parameters

app
IApplicationBuilder

The IApplicationBuilder to configure.

Returns

IApplicationBuilder

The IApplicationBuilder.

Applies to

UseWebSockets(IApplicationBuilder, WebSocketOptions)

Source:
WebSocketMiddlewareExtensions.cs

Adds the WebSocketMiddleware to the request pipeline.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Builder::IApplicationBuilder ^ UseWebSockets(Microsoft::AspNetCore::Builder::IApplicationBuilder ^ app, Microsoft::AspNetCore::Builder::WebSocketOptions ^ options);
public static Microsoft.AspNetCore.Builder.IApplicationBuilder UseWebSockets (this Microsoft.AspNetCore.Builder.IApplicationBuilder app, Microsoft.AspNetCore.Builder.WebSocketOptions options);
static member UseWebSockets : Microsoft.AspNetCore.Builder.IApplicationBuilder * Microsoft.AspNetCore.Builder.WebSocketOptions -> Microsoft.AspNetCore.Builder.IApplicationBuilder
<Extension()>
Public Function UseWebSockets (app As IApplicationBuilder, options As WebSocketOptions) As IApplicationBuilder

Parameters

app
IApplicationBuilder

The IApplicationBuilder to configure.

options
WebSocketOptions

The WebSocketOptions to be used for the WebSocketMiddleware.

Returns

IApplicationBuilder

The IApplicationBuilder.

Applies to