Export (0) Print
Expand All

HttpListenerContext.AcceptWebSocketAsync Method (String, TimeSpan)

.NET Framework 4.6 and 4.5

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

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

member AcceptWebSocketAsync : 
        subProtocol:string * 
        keepAliveInterval:TimeSpan -> Task<HttpListenerWebSocketContext> 

Parameters

subProtocol
Type: System.String

The supported WebSocket sub-protocol.

keepAliveInterval
Type: System.TimeSpan

The WebSocket protocol keep-alive interval in milliseconds.

Return Value

Type: System.Threading.Tasks.Task(HttpListenerWebSocketContext)
Returns Task(TResult).
The task object representing the asynchronous operation. The Result property on the task object returns an HttpListenerWebSocketContext object.

ExceptionCondition
ArgumentException

subProtocol is an empty string

-or-

subProtocol contains illegal characters.

ArgumentOutOfRangeException

keepAliveInterval is too small.

WebSocketException

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

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

The size of the receive buffer is 16,385 bytes.

.NET Framework

Supported in: 4.6, 4.5
Show:
© 2015 Microsoft