Export (0) Print
Expand All

HttpListenerContext.AcceptWebSocketAsync Method (String, Int32, TimeSpan, ArraySegment(Byte))

.NET Framework 4.5

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

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

member AcceptWebSocketAsync : 
        subProtocol:string * 
        receiveBufferSize:int * 
        keepAliveInterval:TimeSpan * 
        internalBuffer:ArraySegment<byte> -> Task<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.

internalBuffer
Type: System.ArraySegment(Byte)

An internal buffer to use for this operation.

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

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.

Show:
© 2014 Microsoft