System.Net.WebSockets.WebSocket.CreateClientWebSocket Method

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.

Syntax

[System.MonoTODO]
public static WebSocket CreateClientWebSocket (System.IO.Stream innerStream, string subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval, bool useZeroMaskingKey, ArraySegment<byte> internalBuffer)

Parameters

innerStream
The connection to be used for IO operations.
subProtocol
The subprotocol accepted by the client.
receiveBufferSize
The size in bytes of the client WebSocket receive buffer.
sendBufferSize
The size in bytes of the client WebSocket send buffer.
keepAliveInterval
Determines how regularly a frame is sent over the connection as a keep-alive. Applies only when the connection is idle.
useZeroMaskingKey
Indicates whether a random key or a static key (just zeros) should be used for the WebSocket masking.
internalBuffer
Will be used as the internal buffer in the WPC. The size has to be at least 2 * ReceiveBufferSize + SendBufferSize + 256 + 20 (16 on 32-bit).

Returns

Returns System.Net.WebSockets.WebSocket.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: System.Net.WebSockets
Assembly: System (in System.dll)
Assembly Versions: 4.0.0.0