Share via

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
Package:
Microsoft.AspNetCore.App.Ref v9.0.0
Source:
WebSocketOptions.cs
Source:
WebSocketOptions.cs

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

The interval to send keep-alive frames. This is a heart-beat that keeps the connection alive. The default is two minutes.
KeepAliveTimeout

The time to wait for a Pong frame response after sending a Ping frame. If the time is exceeded the websocket will be aborted.
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