WebSocketSharp.Net.ClientSslConfiguration Class Reference

Stores the parameters for the SslStream used by clients. More...

Public Member Functions
	ClientSslConfiguration (string targetHost)
	Initializes a new instance of the ClientSslConfiguration class with the specified target host server name.
	ClientSslConfiguration (ClientSslConfiguration configuration)
	Initializes a new instance of the ClientSslConfiguration class that stores the parameters copied from the specified configuration.

Properties
bool	CheckCertificateRevocation [get, set]
	Gets or sets a value indicating whether the certificate revocation list is checked during authentication.
X509CertificateCollection	ClientCertificates [get, set]
	Gets or sets the collection of client certificates from which to select one to supply to the server.
LocalCertificateSelectionCallback	ClientCertificateSelectionCallback [get, set]
	Gets or sets the callback used to select the certificate to supply to the server.
SslProtocols	EnabledSslProtocols [get, set]
	Gets or sets the protocols used for authentication.
RemoteCertificateValidationCallback	ServerCertificateValidationCallback [get, set]
	Gets or sets the callback used to validate the certificate supplied by the server.
string	TargetHost [get, set]
	Gets or sets the target host server name.

Detailed Description

Stores the parameters for the SslStream used by clients.

Constructor & Destructor Documentation

ClientSslConfiguration() [1/2]

WebSocketSharp.Net.ClientSslConfiguration.ClientSslConfiguration ( string  targetHost )

inline

Initializes a new instance of the ClientSslConfiguration class with the specified target host server name.

Parameters

targetHost

A string that specifies the target host server name.

Exceptions

ArgumentNullException	targetHost is null.
ArgumentException	targetHost is an empty string.

ClientSslConfiguration() [2/2]

WebSocketSharp.Net.ClientSslConfiguration.ClientSslConfiguration ( ClientSslConfiguration  configuration )

inline

Initializes a new instance of the ClientSslConfiguration class that stores the parameters copied from the specified configuration.

Parameters

configuration

A ClientSslConfiguration from which to copy.

Exceptions

ArgumentNullException

configuration is null.

Property Documentation

CheckCertificateRevocation

bool WebSocketSharp.Net.ClientSslConfiguration.CheckCertificateRevocation

getset

Gets or sets a value indicating whether the certificate revocation list is checked during authentication.

true if the certificate revocation list is checked during authentication; otherwise, false.

The default value is false.

ClientCertificates

X509CertificateCollection WebSocketSharp.Net.ClientSslConfiguration.ClientCertificates

getset

Gets or sets the collection of client certificates from which to select one to supply to the server.

A X509CertificateCollection or null.

The collection contains client certificates from which to select.

The default value is null.

ClientCertificateSelectionCallback

LocalCertificateSelectionCallback WebSocketSharp.Net.ClientSslConfiguration.ClientCertificateSelectionCallback

getset

Gets or sets the callback used to select the certificate to supply to the server.

No certificate is supplied if the callback returns null.

A LocalCertificateSelectionCallback delegate that invokes the method called for selecting the certificate.

The default value is a delegate that invokes a method that only returns null.

EnabledSslProtocols

SslProtocols WebSocketSharp.Net.ClientSslConfiguration.EnabledSslProtocols

getset

Gets or sets the protocols used for authentication.

Any of the SslProtocols enum values.

It represents the protocols used for authentication.

The default value is SslProtocols.None.

ServerCertificateValidationCallback

RemoteCertificateValidationCallback WebSocketSharp.Net.ClientSslConfiguration.ServerCertificateValidationCallback

getset

Gets or sets the callback used to validate the certificate supplied by the server.

The certificate is valid if the callback returns true.

A RemoteCertificateValidationCallback delegate that invokes the method called for validating the certificate.

The default value is a delegate that invokes a method that only returns true.

TargetHost

string WebSocketSharp.Net.ClientSslConfiguration.TargetHost

getset

Gets or sets the target host server name.

A string that represents the name of the server that will share a secure connection with a client.

Exceptions

ArgumentNullException	The value specified for a set operation is null.
ArgumentException	The value specified for a set operation is an empty string.

---

The documentation for this class was generated from the following file:

• C:/Transhuman/S2/Assets/Plugins/Teal-Net/Plugins/websocket-sharp/Net/ClientSslConfiguration.cs