System.Net.WebSockets Represents the result of performing a single operation on a . Initializes a new instance of the struct. An instance of this struct represents the result of performing a single ReceiveAsync operation on a . The number of bytes that the received. One of the enumeration values that indicates whether the current message is a UTF-8 message or a binary message. to indicate the messsage has been received completely; otherwise, . Gets the number of bytes that the received. The number of bytes that the received. Gets whether the message has been received completely. if the message was received completely; otherwise, . Gets the type of the current message. One of the enumeration values that specifies if the current message is a UTF-8, binary, or close message. The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed. Creates an instance of the class. Aborts the WebSocket connection and cancels any pending IO operations. Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7. Indicates the reason for closing the WebSocket connection. Specifies a human readable explanation as to why the connection is closed. The token that can be used to propagate notification that operations should be canceled. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. Initiates or completes the close handshake defined in the WebSocket protocol specification section 7. Indicates the reason for closing the WebSocket connection. Allows applications to specify a human readable explanation as to why the connection is closed. The token that can be used to propagate notification that operations should be canceled. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. Create client buffers to use with this instance. The size, in bytes, of the client receive buffer. The size, in bytes, of the send buffer. An array with the client buffers. Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes. The connection to be used for IO operations. The subprotocol accepted by the client. The size in bytes of the client WebSocket receive buffer. The size in bytes of the client WebSocket send buffer. Determines how regularly a frame is sent over the connection as a keep-alive. Applies only when the connection is idle. Indicates whether a random key or a static key (just zeros) should be used for the WebSocket masking. 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 . Creates a new object that operates on the specified stream, which represents a web socket connection. The stream for the connection. to indicate it's the server-side of the connection; if it's the client-side. The agreed upon sub-protocol that was used when creating the connection. The keep-alive interval to use, or to disable keep-alives. The new web socket. Creates a that operates on a representing a web socket connection. The for the connection. The options with which the websocket must be created. The created web socket. Creates a WebSocket server buffer. The size, in bytes, of the desired buffer. Returns . Used to clean up unmanaged resources for ASP.NET and self-hosted implementations. Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5. if the is targeting .NET Framework 4.5; otherwise, . Returns a value that indicates if the state of the WebSocket instance is closed or aborted. The current state of the WebSocket. if the is closed or aborted; otherwise, . Receives data from the connection asynchronously. References the application buffer that is the storage location for the received data. Propagates the notification that operations should be canceled. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. The property on the task object returns a object that represents the received data. Receives data from the connection asynchronously. The application buffer that is the storage location for the received data. The cancellation token to use to cancel the receive operation. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. The property on the task object returns a object that represents the received data. Allows callers to register prefixes for WebSocket requests (ws and wss). Sends data over the connection asynchronously. The buffer to be sent over the connection. Indicates whether the application is sending a binary or text message. Indicates whether the data in "buffer" is the last part of a message. The token that propagates the notification that operations should be canceled. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. Sends data over the connection asynchronously. The buffer to be sent over the connection. One of the enumeration values that indicates whether the application is sending a binary or text message. to indicate the data in "buffer" is the last part of a message; otherwise, . The cancellation token to use to cancel the send operation. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. Sends data over the connection asynchronously. The buffer to be sent over the connection. One of the enumeration values that indicates whether the application is sending a binary or text message. Flags for controlling how the should send a message. The cancellation token to use to cancel the send operation. The cancellation token was canceled. This exception is stored into the returned task. The task object representing the asynchronous operation. Verifies that the connection is in an expected state. The current state of the WebSocket to be tested against the list of valid states. List of valid connection states. Indicates the reason why the remote endpoint initiated the close handshake. Returns . Allows the remote endpoint to describe the reason why the connection was closed. Returns . Gets the default WebSocket protocol keep-alive interval. The default WebSocket protocol keep-alive interval. The typical value for this interval is 30 seconds (as defined by the OS or the .NET platform). It is used to initialize value. Returns the current state of the WebSocket connection. The current state of the WebSocket connection. Gets the subprotocol that was negotiated during the opening handshake. The subprotocol that was negotiated during the opening handshake. Represents well known WebSocket close codes as defined in section 11.7 of the WebSocket protocol spec. No error specified. (1001) Indicates an endpoint is being removed. Either the server or client will become unavailable. (1011) The connection will be closed by the server because of an error on the server. (1003) The client or server is terminating the connection because it cannot accept the data type it received. (1007) The client or server is terminating the connection because it has received data inconsistent with the message type. (1010) The client is terminating the connection because it expected the server to negotiate an extension. (1009) The client or server is terminating the connection because it has received a message that is too big for it to process. (1000) The connection has closed after the request was fulfilled. (1008) The connection will be closed because an endpoint has received a message that violates its policy. (1002) The client or server is terminating the connection because of a protocol error. Used for accessing the information in the WebSocket handshake. Creates an instance of the class. The cookies that were passed to the server during the opening handshake. Returns . The HTTP headers that were sent to the server during the opening handshake. Returns . Whether the WebSocket client is authenticated. Returns . Whether the WebSocket client connected from the local machine. Returns . Whether the WebSocket connection is secured using Secure Sockets Layer (SSL). Returns . The value of the Origin HTTP header included in the opening handshake. Returns . The URI requested by the WebSocket client. Returns . The value of the SecWebSocketKey HTTP header included in the opening handshake. Returns . The value of the SecWebSocketKey HTTP header included in the opening handshake. Returns . The list of subprotocols requested by the WebSocket client. Returns . An object used to obtain identity, authentication information, and security roles for the WebSocket client. Returns . The WebSocket instance used to interact (send/receive/close/etc) with the WebSocket connection. Returns . Options that control how a is created. Creates an instance of the class. The agreed upon options for per message deflate. Be aware that enabling compression makes the application subject to CRIME/BREACH type of attacks. It is strongly advised to turn off compression when sending data containing secrets by specifying flag for such messages. Defines if this websocket is the server-side of the connection. The default value is . The keep-alive interval to use, or or to disable keep-alives. The default is . The timeout to use when waiting for the peer's PONG in response to us sending a PING; or or to disable waiting for peer's response, and use an unsolicited PONG as a Keep-Alive heartbeat instead. The default is . The agreed upon sub-protocol that was used when creating the connection. Options to enable per-message deflate compression for . Creates an instance of the class. When the client-side of the connection indicates that it will persist the deflate context accross messages. The default is . This parameter indicates the base-2 logarithm for the LZ77 sliding window size used by the client to compress messages and by the server to decompress them. Must be a value between 9 and 15. The default is 15. When the server-side of the connection indicates that it will persist the deflate context accross messages. The default is . This parameter indicates the base-2 logarithm for the LZ77 sliding window size used by the server to compress messages and by the client to decompress them. Must be a value between 9 and 15. The default is 15. Contains the list of possible WebSocket errors. Indicates that the connection was terminated unexpectedly. Indicates a general error. Indicates an error occurred when parsing the HTTP headers during the opening handshake. Indicates that a WebSocket frame with an unknown opcode was received. Indicates the WebSocket is an invalid state for the given operation (such as being closed or aborted). Indicates that an unknown native error occurred. Indicates that the incoming request was not a valid websocket request. Indicates that there was no native error information for the exception. Indicates that the client requested an unsupported WebSocket subprotocol. Indicates that the client requested an unsupported version of the WebSocket protocol. Represents an exception that occurred when performing an operation on a WebSocket connection. Creates an instance of the class. Creates an instance of the class. The native error code for the exception. Indicates the previous exception that led to the current exception. Creates an instance of the class. The native error code for the exception. The description of the error. Creates an instance of the class. The native error code for the exception. Creates an instance of the class. The error from the WebSocketError enumeration. Indicates the previous exception that led to the current exception. Creates an instance of the class. The error from the WebSocketError enumeration. The native error code for the exception. Indicates the previous exception that led to the current exception. Creates an instance of the class. The error from the WebSocketError enumeration. The native error code for the exception. The description of the error. Indicates the previous exception that led to the current exception. Creates an instance of the class. The error from the WebSocketError enumeration. The native error code for the exception. The description of the error. Creates an instance of the class. The error from the WebSocketError enumeration. The native error code for the exception. Creates an instance of the class. The error from the WebSocketError enumeration. The description of the error. Indicates the previous exception that led to the current exception. Creates an instance of the class. The error from the WebSocketError enumeration. The description of the error. Creates an instance of the class. The error from the WebSocketError enumeration. Creates an instance of the class. The description of the error. Indicates the previous exception that led to the current exception. Creates an instance of the class. The description of the error. Sets the SerializationInfo object with the file name and line number where the exception occurred. A SerializationInfo object. The contextual information about the source or destination. The native error code for the exception that occurred. Returns . Returns a WebSocketError indicating the type of error that occurred. Returns . Flags for controlling how the should send a message. Disables compression for the message if compression has been enabled for the instance. Indicates that the data in "buffer" is the last part of a message. None Indicates the message type. The message is in binary format. A receive has completed because a close message was received. The message is clear text. An instance of this class represents the result of performing a single ReceiveAsync operation on a WebSocket. Creates an instance of the class. The number of bytes received. The type of message that was received. Indicates whether this is the final message. Indicates the of the connection. The description of . Creates an instance of the class. The number of bytes received. The type of message that was received. Indicates whether this is the final message. Indicates the reason why the remote endpoint initiated the close handshake. Returns . Returns the optional description that describes why the close handshake has been initiated by the remote endpoint. Returns . Indicates the number of bytes that the WebSocket received. Returns . Indicates whether the message has been received completely. Returns . Indicates whether the current message is a UTF-8 message or a binary message. Returns . Defines the different states a WebSockets instance can be in. Indicates that the WebSocket has been aborted. Indicates the WebSocket close handshake completed gracefully. A close message was received from the remote endpoint. A close message was sent to the remote endpoint. The connection is negotiating the handshake with the remote endpoint. Reserved for future use. The initial state after the HTTP handshake has been completed. Provides a that delegates to a wrapped . Begins an asynchronous read operation. (Consider using instead.) The buffer to read the data into. The byte offset in buffer at which to begin writing data read from the stream. The maximum number of bytes to read. An optional asynchronous callback, to be called when the read is complete. A user-provided object that distinguishes this particular asynchronous read request from other requests. An that represents the asynchronous read, which could still be pending. Begins an asynchronous write operation. (Consider using instead.) The buffer to write data from. The byte offset in buffer from which to begin writing. The maximum number of bytes to write. An optional asynchronous callback, to be called when the write is complete. A user-provided object that distinguishes this particular asynchronous write request from other requests. An IAsyncResult that represents the asynchronous write, which could still be pending. Creates a that delegates to a wrapped . The wrapped . The type of messages that should be written as part of calls. Each write produces a message. if disposing the should close the underlying ; otherwise, . Defaults to . A new instance of that forwards reads and writes on the to the underlying . Creates a that delegates to a wrapped . The wrapped . The type of messages that should be written as part of calls. Each write produces a message. The amount of time that disposing the will wait for a graceful closing of the 's output. A new instance of that forwards reads and writes on the to the underlying . Creates a that reads a single message from the underlying . The wrapped . A new instance of that forwards reads on the to the underlying . Creates a that writes a single message to the underlying . The wrapped . The type of messages that should be written as part of calls. Each write on the results in writing a partial message to the underlying . When the is disposed, it will write an empty message to the underlying to signal the end of the message. A new instance of that forwards writes on the to the underlying . Releases the unmanaged resources used by the and optionally releases the managed resources. true to release both managed and unmanaged resources; false to release only unmanaged resources. Waits for the pending asynchronous read to complete. (Consider using instead.) The reference to the pending asynchronous request to finish. The number of bytes read from the stream, between zero (0) and the number of bytes requested. ReadAsync returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data). Ends an asynchronous write operation. (Consider using instead.) A reference to the outstanding asynchronous I/O request. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device. Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous flush operation. When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. The zero-based byte offset in buffer at which to begin storing the data read from the current stream. The maximum number of bytes to be read from the current stream. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached. Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. The buffer to write the data into. The byte offset in buffer at which to begin writing data from the stream. The maximum number of bytes to read. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached. Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. The region of memory to write the data into. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous read operation. The value of its property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached. When overridden in a derived class, sets the position within the current stream. A byte offset relative to the origin parameter. A value of type indicating the reference point used to obtain the new position. The new position within the current stream. When overridden in a derived class, sets the length of the current stream. The desired length of the current stream in bytes. When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. An array of bytes. This method copies count bytes from buffer to the current stream. The zero-based byte offset in buffer at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. The buffer to write data from. The zero-based byte offset in buffer from which to begin copying bytes to the stream. The maximum number of bytes to write. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous write operation. Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. The region of memory to write data from. The token to monitor for cancellation requests. The default value is . A task that represents the asynchronous write operation. When overridden in a derived class, gets a value indicating whether the current stream supports reading. true if the stream supports reading; otherwise, false. When overridden in a derived class, gets a value indicating whether the current stream supports seeking. true if the stream supports seeking; otherwise, false. When overridden in a derived class, gets a value indicating whether the current stream supports writing. true if the stream supports writing; otherwise, false. When overridden in a derived class, gets the length in bytes of the stream. A long value representing the length of the stream in bytes. When overridden in a derived class, gets or sets the position within the current stream. The current position within the stream. Gets the underlying wrapped by this .