WebSocketCreationOptions Class

Definition

Namespace:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Source:

WebSocketCreationOptions.cs

Options that control how a WebSocket is created.

public ref class WebSocketCreationOptions sealed

public sealed class WebSocketCreationOptions

type WebSocketCreationOptions = class

Public NotInheritable Class WebSocketCreationOptions

Inheritance

Object

WebSocketCreationOptions

Constructors

WebSocketCreationOptions()

Creates an instance of the WebSocketCreationOptions class.

Properties

DangerousDeflateOptions	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 DisableCompression flag for such messages.
IsServer	Defines if this websocket is the server-side of the connection. The default value is false.
KeepAliveInterval	The keep-alive interval to use, or Zero or InfiniteTimeSpan to disable keep-alives. The default is Zero.
KeepAliveTimeout	The timeout to use when waiting for the peer's PONG in response to us sending a PING; or Zero or InfiniteTimeSpan to disable waiting for peer's response, and use an unsolicited PONG as a Keep-Alive heartbeat instead. The default is InfiniteTimeSpan.
SubProtocol	The agreed upon sub-protocol that was used when creating the connection.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)