WebSocketAcceptContext Class

Definition

Namespace:

Microsoft.AspNetCore.Http

Assembly:

Microsoft.AspNetCore.Http.Features.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

A context for negotiating a websocket upgrade.

public ref class WebSocketAcceptContext

public class WebSocketAcceptContext

type WebSocketAcceptContext = class

Public Class WebSocketAcceptContext

Inheritance

Object

WebSocketAcceptContext

Derived

Microsoft.AspNetCore.Owin.OwinWebSocketAcceptContext

Microsoft.AspNetCore.WebSockets.ExtendedWebSocketAcceptContext

Microsoft.AspNetCore.WebSockets.Server.ExtendedWebSocketAcceptContext

Constructors

WebSocketAcceptContext()

Properties

DangerousEnableCompression	Enables support for the 'permessage-deflate' WebSocket extension. Be aware that enabling compression over encrypted connections makes the application subject to CRIME/BREACH type attacks. It is strongly advised to turn off compression when sending data containing secrets by specifying DisableCompression when sending such messages.
DisableServerContextTakeover	Disables server context takeover when using compression. This setting reduces the memory overhead of compression at the cost of a potentially worse compression ratio.
KeepAliveInterval	The interval to send keep-alive frames. This is a heart-beat that keeps the connection alive.
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.
ServerMaxWindowBits	Sets the maximum base-2 logarithm of the LZ77 sliding window size that can be used for compression. This setting reduces the memory overhead of compression at the cost of a potentially worse compression ratio.
SubProtocol	Gets or sets the subprotocol being negotiated.