System.Net.WebSockets.WebSocket: Method Members

The methods of System.Net.WebSockets.WebSocket are listed below. For a list of all members, see the WebSocket Members list.

See Also: Inherited members from System.Object

Public Methods

abstract
Abort()

Aborts the WebSocket connection and cancels any pending IO operations.

abstract
CloseAsync(System.Net.WebSockets.WebSocketCloseStatus, string, System.Threading.CancellationToken) : System.Threading.Tasks.Task

Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the tp://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06 section 7.

abstract
CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus, string, System.Threading.CancellationToken) : System.Threading.Tasks.Task

Initiates or completes the close handshake defined in the tp://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06.

static
CreateClientBuffer(int, int) : ArraySegment<byte>

Create client buffers to use with this System.Net.WebSockets.WebSocket instance.

static
CreateClientWebSocket(System.IO.Stream, string, int, int, TimeSpan, bool, ArraySegment<byte>) : System.Net.WebSockets.WebSocket

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.

static
CreateServerBuffer(int) : ArraySegment<byte>

Creates a WebSocket server buffer.

abstract
Dispose()

Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.

static
IsApplicationTargeting45() : bool

Returns a value that indicates if the WebSocket instance is targeting net_v45.

abstract
ReceiveAsync(ArraySegment<byte>, System.Threading.CancellationToken) : System.Threading.Tasks.Task<System.Net.WebSockets.WebSocketReceiveResult>

Receives data from the WebSocket connection asynchronously.

static
RegisterPrefixes()

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code. Allows callers to register prefixes for WebSocket requests (ws and wss).

abstract
SendAsync(ArraySegment<byte>, System.Net.WebSockets.WebSocketMessageType, bool, System.Threading.CancellationToken) : System.Threading.Tasks.Task

Sends data over the WebSocket connection asynchronously.

Protected Methods

static
IsStateTerminal(System.Net.WebSockets.WebSocketState) : bool

Returns a value that indicates if the state of the WebSocket instance is closed or aborted.

static
ThrowOnInvalidState(System.Net.WebSockets.WebSocketState, params System.Net.WebSockets.WebSocketState[])

Verifies that the connection is in an expected state.