WebSocketManager.AcceptWebSocketAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Abstractions.dll
Package:
Microsoft.AspNetCore.Http.Abstractions v1.0.0
Package:
Microsoft.AspNetCore.Http.Abstractions v1.1.0
Package:
Microsoft.AspNetCore.Http.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Http.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Http.Abstractions 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

Overloads

AcceptWebSocketAsync()

Transitions the request to a WebSocket connection.
AcceptWebSocketAsync(WebSocketAcceptContext)
AcceptWebSocketAsync(String)

Transitions the request to a WebSocket connection using the specified sub-protocol.

AcceptWebSocketAsync()

Source:
WebSocketManager.cs
Source:
WebSocketManager.cs

Transitions the request to a WebSocket connection.

public:
 virtual System::Threading::Tasks::Task<System::Net::WebSockets::WebSocket ^> ^ AcceptWebSocketAsync();
public virtual System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket> AcceptWebSocketAsync ();
abstract member AcceptWebSocketAsync : unit -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket>
override this.AcceptWebSocketAsync : unit -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket>
Public Overridable Function AcceptWebSocketAsync () As Task(Of WebSocket)

Returns

Task<WebSocket>

A task representing the completion of the transition.

Applies to

AcceptWebSocketAsync(WebSocketAcceptContext) 

public virtual System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket> AcceptWebSocketAsync (Microsoft.AspNetCore.Http.WebSocketAcceptContext acceptContext);
abstract member AcceptWebSocketAsync : Microsoft.AspNetCore.Http.WebSocketAcceptContext -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket>
override this.AcceptWebSocketAsync : Microsoft.AspNetCore.Http.WebSocketAcceptContext -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket>
Public Overridable Function AcceptWebSocketAsync (acceptContext As WebSocketAcceptContext) As Task(Of WebSocket)

Parameters

acceptContext
WebSocketAcceptContext

Returns

Task<WebSocket>

Applies to

AcceptWebSocketAsync(String)

Source:
WebSocketManager.cs
Source:
WebSocketManager.cs

Transitions the request to a WebSocket connection using the specified sub-protocol.

public:
 abstract System::Threading::Tasks::Task<System::Net::WebSockets::WebSocket ^> ^ AcceptWebSocketAsync(System::String ^ subProtocol);
public abstract System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket> AcceptWebSocketAsync (string subProtocol);
public abstract System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket> AcceptWebSocketAsync (string? subProtocol);
abstract member AcceptWebSocketAsync : string -> System.Threading.Tasks.Task<System.Net.WebSockets.WebSocket>
Public MustOverride Function AcceptWebSocketAsync (subProtocol As String) As Task(Of WebSocket)

Parameters

subProtocol
String

The sub-protocol to use.

Returns

Task<WebSocket>

A task representing the completion of the transition.

Applies to