WebSocketMiddleware.Invoke(HttpContext) Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.WebSockets

Assembly:: Microsoft.AspNetCore.WebSockets.dll

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.0-preview.5.22303.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Processes a request to determine if it is a WebSocket request, and if so, sets the IHttpWebSocketFeature on the Features.

public:
 System::Threading::Tasks::Task ^ Invoke(Microsoft::AspNetCore::Http::HttpContext ^ context);

public System.Threading.Tasks.Task Invoke (Microsoft.AspNetCore.Http.HttpContext context);

member this.Invoke : Microsoft.AspNetCore.Http.HttpContext -> System.Threading.Tasks.Task

Public Function Invoke (context As HttpContext) As Task

Parameters

context: HttpContext

The HttpContext representing the request.

Returns

Task

The Task that represents the completion of the middleware pipeline.

Applies to