Bewerken

Share via

ClientWebSocketOptions Class

  • Reference

Definition

Namespace:
System.Net.WebSockets
Assembly:
System.Net.WebSockets.Client.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
ClientWebSocketOptions.cs
Source:
ClientWebSocketOptions.cs
Source:
ClientWebSocketOptions.cs

Options to use with a ClientWebSocket object.

public ref class ClientWebSocketOptions sealed
public sealed class ClientWebSocketOptions
type ClientWebSocketOptions = class
Public NotInheritable Class ClientWebSocketOptions
Inheritance
Object
ClientWebSocketOptions

Properties

ClientCertificates

Gets or sets a collection of client side certificates.
CollectHttpResponseDetails

Gets or sets a value that indicates whether HttpStatusCode and HttpResponseHeaders should be set when establishing the connection.
Cookies

Gets or sets the cookies associated with the request.
Credentials

Gets or sets the credential information for the client.
DangerousDeflateOptions

Gets or sets the options for the per-message-deflate extension. When present, the options are sent to the server during the handshake phase. If the server supports per-message-deflate and the options are accepted, the WebSocket instance will be created with compression enabled by default for all messages.

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

Gets or sets the HTTP version to use.
HttpVersionPolicy

Gets or sets the policy that determines how HttpVersion is interpreted and how the final HTTP version is negotiated with the server.
KeepAliveInterval

Gets or sets the WebSocket protocol keep-alive interval.
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.
Proxy

Gets or sets the proxy for WebSocket requests.
RemoteCertificateValidationCallback

Gets or sets the callback to validate a server certificate.
UseDefaultCredentials

Gets or sets a Boolean value that indicates if default credentials should be used during WebSocket handshake.

Methods

AddSubProtocol(String)

Adds a sub-protocol to be negotiated during the WebSocket connection handshake.
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)
SetBuffer(Int32, Int32)

Sets the client buffer parameters.
SetBuffer(Int32, Int32, ArraySegment<Byte>)

Sets client buffer parameters.
SetRequestHeader(String, String)

Creates a HTTP request header and its value.
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to