HttpListenerContext.AcceptWebSocketAsync Method (String, Int32, TimeSpan)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Accept a WebSocket connection specifying the supported WebSocket sub-protocol, receive buffer size, and WebSocket keep-alive interval as an asynchronous operation.

Namespace:   System.Net
Assembly:  System (in System.dll)

Public Function AcceptWebSocketAsync (
	subProtocol As String,
	receiveBufferSize As Integer,
	keepAliveInterval As TimeSpan
) As Task(Of HttpListenerWebSocketContext)

Parameters

subProtocol
Type: System.String

The supported WebSocket sub-protocol.

receiveBufferSize
Type: System.Int32

The receive buffer size in bytes.

keepAliveInterval
Type: System.TimeSpan

The WebSocket protocol keep-alive interval in milliseconds.

Return Value

Type: System.Threading.Tasks.Task(Of HttpListenerWebSocketContext)

Returns Task(Of TResult).

The task object representing the asynchronous operation. The Result property on the task object returns an HttpListenerWebSocketContext object.

Exception Condition
ArgumentException

subProtocol is an empty string

-or-

subProtocol contains illegal characters.

ArgumentOutOfRangeException

keepAliveInterval is too small.

-or-

receiveBufferSize is less than 16 bytes

-or-

receiveBufferSize is greater than 64K bytes.

WebSocketException

An error occurred when sending the response to complete the WebSocket handshake.

This operation will not block. The returned Task(Of TResult) > object will complete after the WebSocket connection has been accepted.

.NET Framework
Available since 4.5
Return to top
Show: