HttpListenerContext.AcceptWebSocketAsync Method (String)
Accept a WebSocket connection as an asynchronous operation.
Namespace: System.Net
Assembly: System (in System.dll)
Parameters
- subProtocol
- Type: System.String
The supported WebSocket sub-protocol.
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.
| Exception | Condition |
|---|---|
| ArgumentException | subProtocol is an empty string -or- subProtocol contains illegal characters. |
| 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. The WebSocket keep-alive interval is set to the default value of 30,000 (30 seconds).
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.
