Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

HttpListenerContext.AcceptWebSocketAsync Method (String, TimeSpan)

.NET Framework 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)
public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(
	string subProtocol,
	TimeSpan keepAliveInterval
)

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.5.1, 4.5

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.