WebSocketOptions Class

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

Source:: WebSocketOptions.cs

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.

Configuration options for the WebSocketMiddleware.

public ref class WebSocketOptions

public class WebSocketOptions

type WebSocketOptions = class

Public Class WebSocketOptions

Inheritance: Object
WebSocketOptions

Constructors

WebSocketOptions()

Constructs the WebSocketOptions class with default values.

Properties

AllowedOrigins	Set the Origin header values allowed for WebSocket requests to prevent Cross-Site WebSocket Hijacking. By default all Origins are allowed.
KeepAliveInterval	Gets or sets the frequency at which to send Ping/Pong keep-alive control frames. The default is two minutes.
ReceiveBufferSize	Obsolete. Gets or sets the size of the protocol buffer used to receive and parse frames. The default is 4kb.
ReplaceFeature	Gets or sets if the middleware should replace the WebSocket implementation provided by a component earlier in the stack. This is false by default.

Applies to