Share via

WebSocketOptions Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Http.Connections
Assembly:
Microsoft.AspNetCore.Http.Connections.dll
Package:
Microsoft.AspNetCore.Http.Connections v1.0.0
Package:
Microsoft.AspNetCore.Http.Connections v1.1.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
Source:
WebSocketOptions.cs

Options used by the WebSockets transport to modify the transports behavior.

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

Constructors

WebSocketOptions()

Properties

CloseTimeout

Gets or sets the amount of time the WebSocket transport will wait for a graceful close before starting an ungraceful close.
SubProtocolSelector

Gets or sets a delegate that will be called when a new WebSocket is established to select the value for the 'Sec-WebSocket-Protocol' response header. The delegate will be called with a list of the protocols provided by the client in the 'Sec-WebSocket-Protocol' request header.

Applies to