ExtendedWebSocketAcceptContext 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:
ExtendedWebSocketAcceptContext.cs
Source:
ExtendedWebSocketAcceptContext.cs

Caution

This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.AspNetCore.Http.WebSocketAcceptContext.

Extends the WebSocketAcceptContext class with additional properties.

public ref class ExtendedWebSocketAcceptContext : Microsoft::AspNetCore::Http::WebSocketAcceptContext
public class ExtendedWebSocketAcceptContext : Microsoft.AspNetCore.Http.WebSocketAcceptContext
[System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.AspNetCore.Http.WebSocketAcceptContext.")]
public class ExtendedWebSocketAcceptContext : Microsoft.AspNetCore.Http.WebSocketAcceptContext
type ExtendedWebSocketAcceptContext = class
    inherit WebSocketAcceptContext
[<System.Obsolete("This type is obsolete and will be removed in a future version. The recommended alternative is Microsoft.AspNetCore.Http.WebSocketAcceptContext.")>]
type ExtendedWebSocketAcceptContext = class
    inherit WebSocketAcceptContext
Public Class ExtendedWebSocketAcceptContext
Inherits WebSocketAcceptContext
Inheritance
Object
WebSocketAcceptContext
ExtendedWebSocketAcceptContext
Attributes
ObsoleteAttribute

Constructors

ExtendedWebSocketAcceptContext()

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.

(Inherited from WebSocketAcceptContext)
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.

(Inherited from WebSocketAcceptContext)
KeepAliveInterval

The interval to send pong 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.

(Inherited from WebSocketAcceptContext)
ReceiveBufferSize
Obsolete.

This property is obsolete and has no effect.
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.

(Inherited from WebSocketAcceptContext)
SubProtocol

Gets or sets the subprotocol being negotiated.

Applies to