WebSocketClient Class
Properties Methods Events Configuration Settings Errors
The WebSocketClient class provides the client-side functionality of the WebSocket protocol.
Syntax
secureblackbox.Websocketclient
Remarks
Use this component to set up secure connections from your application with a WebSocket server.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BlockedCertificates | The certificates that must be rejected as trust anchors. |
ClientChain | The TLS client certificate chain. |
Connected | Indicates whether the connection is active. |
ConnectionInfo | Returns the details of the underlying network connection. |
ExternalCrypto | Provides access to external signing and DC parameters. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
Proxy | The proxy server settings. |
RequestParameters | Provides access to common HTTP request properties. |
ServerChain | The TLS server's certificate chain. |
SocketSettings | Manages network connection settings. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
UseDigestAuth | Enables or disables the HTTP Digest authentication. |
UseNTLMAuth | Enables or disables NTLM authentication. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Connect | Establishes connection to the server. |
Disconnect | Disconnects from the server. |
SendData | Sends a piece of binary data to the server. |
SendKeepAlive | Sends a keep-alive message. |
SendText | Sends a piece of text data to the server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
BinaryData | Passes a received chunk of binary data to the application. |
CertificateValidate | Fires when the server's TLS certificate has to be validated. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
KeepAliveResponse | Reports a response to a keep-alive message. |
Notification | This event notifies the application about an underlying control flow event. |
TextData | Passes a received chunk of text data to the application. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
CacheStreamOutput | Tells the class whether to cache stream- and file-bound responses in the class. |
ForceNTLMAuth | Activates and enforces NTLM authentication. |
IgnoreUnknownTransferEncodings | All incoming responses with unknown transfer encodings are ignored if this property is true. |
MaxRedirections | The maximum number of HTTP redirects. |
PersistentAuthHeader | Whether to resend NTLM negotiation on every request. |
RequestCompressionGZip | Ask server to use GZip compression. |
RequestCompressionLevel | Ask server to use the specified compression level. |
SendBufferSize | Size of send buffer in bytes. |
SuppressRedirectionContent | Whether to suppress the redirection content. |
TempPath | Path for storing temporary files. |
Use100Continue | Whether to use 100-continue for POST and PUT commands. |
UseCompression | Whether to use GZip compression. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |