Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
AcceptWebSocketAsync Method (String, Int32, TimeSpan)

HttpListenerContext::AcceptWebSocketAsync Method (String, Int32, TimeSpan)

.NET Framework 4.6 and 4.5

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:
Task<HttpListenerWebSocketContext^>^ AcceptWebSocketAsync(
	String^ subProtocol, 
	int receiveBufferSize, 
	TimeSpan keepAliveInterval
)

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<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.

-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<TResult> > object will complete after the WebSocket connection has been accepted.

.NET Framework

Supported in: 4.6, 4.5
Show:
© 2015 Microsoft