WebSocketMiddleware Class

  • 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.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3
Source:
WebSocketMiddleware.cs
Source:
WebSocketMiddleware.cs

Enables accepting WebSocket requests by adding a IHttpWebSocketFeature to the HttpContext if the request is a valid WebSocket request.

public ref class WebSocketMiddleware
public class WebSocketMiddleware
type WebSocketMiddleware = class
Public Class WebSocketMiddleware
Inheritance
Object
WebSocketMiddleware

Constructors

WebSocketMiddleware(RequestDelegate, IOptions<WebSocketOptions>, ILoggerFactory)

Creates a new instance of the WebSocketMiddleware.
WebSocketMiddleware(RequestDelegate, IOptions<WebSocketOptions>)

Methods

Invoke(HttpContext)

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

Applies to