Struct ipworksssl::WSClient

Properties   Methods   Events   Config Settings   Errors  

The WSClient struct is used to establish a WebSocket connection to a server.

Syntax

ipworksssl::WSClient

Remarks

The WSClient struct provides a simple way to establish a WebSocket connection to a server. The server must support the WebSocket protocol. After the connection is established, data can be sent and received.

To begin, call the connect method. After the connection is established, you can send and receive data in a variety of ways. To send data, you may call send, send_file, or send_text. Data are received through the on_data_in event.

The struct supports both plaintext (ws://) and Secure Sockets Layer (wss://) connections.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSSL. Due to this, the WSClient struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of WSClient when you have finished using the instance.

Property List

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

accept_data property (WSClient Struct)

This property indicates whether data reception is currently enabled.

Syntax

fn accept_data(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

true

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled and the on_data_in event will not fire. Use the pause_data and process_data methods to pause and resume data reception.

This property is read-only.

Data Type

bool

authorization property (WSClient Struct)

This property includes the Authorization string to be sent to the server.

Syntax

fn authorization(&self ) -> Result<String, IPWorksSSLError> 
fn set_authorization(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_authorization_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

If the authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

Data Type

String

auth_scheme property (WSClient Struct)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

fn auth_scheme(&self ) -> Result<i32, IPWorksSSLError> 
fn set_auth_scheme(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate
6   // OAuth

Default Value

0

Remarks

This property will tell the struct which type of authorization to perform when the user and password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the user and password properties are set, the struct will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.

If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.

NOTE: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the struct.

For security, changing the value of this property will cause the struct to clear the values of user, password, and Authorization.

Data Type

i32

bytes_sent property (WSClient Struct)

This property includes the number of bytes actually sent after a call to the SendBytes method.

Syntax

fn bytes_sent(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property indicates how many bytes were sent after the last call to send_bytes. Please check the send_bytes method for more information.

NOTE: that bytes_sent will always return 0 when the struct is operating in synchronous mode (i.e., the timeout property is set to a positive value.)

This property is read-only.

Data Type

i32

compression_method property (WSClient Struct)

This property determines whether the struct will request that data in the connection be compressed.

Syntax

fn compression_method(&self ) -> Result<i32, IPWorksSSLError> 
fn set_compression_method(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // None
1   // Deflate

Default Value

0

Remarks

This property determines whether data in the connection will be compressed. Possible values are as follows:

Data Type

i32

connected property (WSClient Struct)

Whether the struct is connected.

Syntax

fn connected(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

This property is used to determine whether or not the struct is connected to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

Data Type

bool

cookie_count property (WSClient Struct)

The number of records in the Cookie arrays.

Syntax

fn cookie_count(&self ) -> Result<i32, IPWorksSSLError> 
fn set_cookie_count(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

The array indices start at 0 and end at cookie_count - 1.

Data Type

i32

cookie_domain property (WSClient Struct)

The domain of a received cookie.

Syntax

fn cookie_domain(&self , CookieIndex : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

String

cookie_expiration property (WSClient Struct)

An expiration time for the cookie (if provided by the server).

Syntax

fn cookie_expiration(&self , CookieIndex : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

String

cookie_name property (WSClient Struct)

The name of the cookie.

Syntax

fn cookie_name(&self , CookieIndex : i32) -> Result<String, IPWorksSSLError> 
fn set_cookie_name(&self, CookieIndex : i32, value : &str) ->  Option<IPWorksSSLError> 
fn set_cookie_name_ref(&self, CookieIndex : i32, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

Data Type

String

cookie_path property (WSClient Struct)

A path name to limit the cookie to (if provided by the server).

Syntax

fn cookie_path(&self , CookieIndex : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

String

cookie_secure property (WSClient Struct)

The security flag of the received cookie.

Syntax

fn cookie_secure(&self , CookieIndex : i32) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only.

Data Type

bool

cookie_value property (WSClient Struct)

The value of the cookie.

Syntax

fn cookie_value(&self , CookieIndex : i32) -> Result<String, IPWorksSSLError> 
fn set_cookie_value(&self, CookieIndex : i32, value : &str) ->  Option<IPWorksSSLError> 
fn set_cookie_value_ref(&self, CookieIndex : i32, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

Data Type

String

data_format property (WSClient Struct)

This property includes the format of the data being sent.

Syntax

fn data_format(&self ) -> Result<i32, IPWorksSSLError> 
fn set_data_format(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Automatic
1   // Text
2   // Binary
9   // Ping
10   // Pong

Default Value

0

Remarks

When data are sent over an established connection, it is usually considered as text or binary data. Text data are UTF-8 encoded. Binary data has no encoding associated with it.

Possible values are as follows:

Data Type

i32

firewall_auto_detect property (WSClient Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, IPWorksSSLError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (WSClient Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, IPWorksSSLError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (WSClient Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, IPWorksSSLError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (WSClient Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, IPWorksSSLError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (WSClient Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, IPWorksSSLError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (WSClient Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, IPWorksSSLError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

follow_redirects property (WSClient Struct)

Determines what happens when the server issues a redirect.

Syntax

fn follow_redirects(&self ) -> Result<i32, IPWorksSSLError> 
fn set_follow_redirects(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Never
1   // Always
2   // SameScheme

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the struct fails with an error.

NOTE: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the struct fails with an error instead.

Data Type

i32

line_mode property (WSClient Struct)

This property indicates whether the struct will fire DataIn for each line received.

Syntax

fn line_mode(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

When line_mode is False (default), the component will fire the on_data_in event once for each message received from the server. When line_mode is True, the component will instead fire on_data_in for each line of data received. The maximum length of a line can be controlled by the MaxLineLength configuration setting.

NOTE: This is a read-only property and should be set through the change_line_mode method.

This property is read-only.

Data Type

bool

local_host property (WSClient Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksSSLError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (WSClient Struct)

The TCP port in the local host where the struct binds.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksSSLError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the local_port property after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

i32

origin property (WSClient Struct)

This property includes the Origin header field value.

Syntax

fn origin(&self ) -> Result<String, IPWorksSSLError> 
fn set_origin(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_origin_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

If specified, the struct will include an Origin HTTP header in the connection request with the value provided. Servers may use this value to validate requests. Servers may reject requests depending on the value provided.

A typical value that would be set is in the following form: "http://example.com".

Data Type

String

other_headers property (WSClient Struct)

Other headers as determined by the user (optional).

Syntax

fn other_headers(&self ) -> Result<String, IPWorksSSLError> 
fn set_other_headers(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_other_headers_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the struct beyond what is provided.

Data Type

String

parsed_header_count property (WSClient Struct)

The number of records in the ParsedHeader arrays.

Syntax

fn parsed_header_count(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

Data Type

i32

parsed_header_field property (WSClient Struct)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

parsed_header_value property (WSClient Struct)

This property contains the header contents.

Syntax

fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

password property (WSClient Struct)

This property includes a password if authentication is to be used.

Syntax

fn password(&self ) -> Result<String, IPWorksSSLError> 
fn set_password(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_password_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, the user and password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the struct will attempt to authenticate using the current user's credentials.

Data Type

String

proxy_auth_scheme property (WSClient Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, IPWorksSSLError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (WSClient Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, IPWorksSSLError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (WSClient Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, IPWorksSSLError> 
fn set_proxy_password(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (WSClient Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, IPWorksSSLError> 
fn set_proxy_port(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (WSClient Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, IPWorksSSLError> 
fn set_proxy_server(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (WSClient Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, IPWorksSSLError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (WSClient Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, IPWorksSSLError> 
fn set_proxy_user(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

ready_to_send property (WSClient Struct)

This property indicates whether the struct is ready to send data.

Syntax

fn ready_to_send(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

This property indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data. This is True after connecting to the remote host and will become False after a failed send_bytes.

After a failed send_bytes, the on_ready_to_send event will fire and this property will be True when data can be sent again.

This property is read-only.

Data Type

bool

ssl_accept_server_cert_effective_date property (WSClient Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (WSClient Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (WSClient Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (WSClient Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (WSClient Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (WSClient Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (WSClient Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (WSClient Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (WSClient Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (WSClient Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (WSClient Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (WSClient Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (WSClient Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (WSClient Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (WSClient Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (WSClient Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (WSClient Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksSSLError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (WSClient Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksSSLError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (WSClient Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (WSClient Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (WSClient Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (WSClient Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (WSClient Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (WSClient Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (WSClient Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (WSClient Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksSSLError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (WSClient Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (WSClient Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (WSClient Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (WSClient Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (WSClient Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (WSClient Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (WSClient Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (WSClient Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (WSClient Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (WSClient Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (WSClient Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (WSClient Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (WSClient Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (WSClient Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (WSClient Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (WSClient Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (WSClient Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (WSClient Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksSSLError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (WSClient Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksSSLError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (WSClient Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (WSClient Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (WSClient Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (WSClient Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (WSClient Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (WSClient Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (WSClient Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (WSClient Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksSSLError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (WSClient Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (WSClient Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksSSLError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (WSClient Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (WSClient Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (WSClient Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (WSClient Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (WSClient Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (WSClient Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (WSClient Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (WSClient Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (WSClient Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (WSClient Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (WSClient Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (WSClient Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (WSClient Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (WSClient Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (WSClient Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (WSClient Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (WSClient Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (WSClient Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksSSLError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (WSClient Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (WSClient Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (WSClient Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (WSClient Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (WSClient Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (WSClient Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (WSClient Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (WSClient Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (WSClient Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

sub_protocols property (WSClient Struct)

This property includes optional subprotocols supported by the client.

Syntax

fn sub_protocols(&self ) -> Result<String, IPWorksSSLError> 
fn set_sub_protocols(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_sub_protocols_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property is optional. Set this property to one or more comma-separated subprotocols that the client supports. These should be provided in order of preference (e.g., chat, superchat).

The server will accept one subprotocol during the connection. After the connection is established, this property will be updated by the struct to reflect the value the server chose. Query this property to determine the negotiated subprotocol.

Data Type

String

timeout property (WSClient Struct)

This property includes the timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksSSLError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

60

Remarks

If the timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If timeout is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

Data Type

i32

transferred_headers property (WSClient Struct)

The full set of headers as received from the server.

Syntax

fn transferred_headers(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The on_header event shows the individual headers as parsed by the struct.

This property is read-only.

Data Type

String

url property (WSClient Struct)

This property specifies the URL that the Connect method will connect to.

Syntax

fn url(&self ) -> Result<String, IPWorksSSLError> 
fn set_url(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_url_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

When the connect method is called, the component will establish a WebSocket connection to the host and port specified in the url property. The URL must be specified in the format "ws://host:[port]/[URI]" for plaintext connections or "wss://host:[port]/[URI]" for Secure Sockets Layer (SSL)-enabled connections.

Data Type

String

user property (WSClient Struct)

This property includes a user name if authentication is to be used.

Syntax

fn user(&self ) -> Result<String, IPWorksSSLError> 
fn set_user(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_user_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, The user and password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the struct will attempt to authenticate using the current user's credentials.

Data Type

String

add_cookie method (WSClient Struct)

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

fn add_cookie(&self, cookie_name : &str, cookie_value : &str) -> Result<(), IPWorksSSLError>

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the cookies property for more information on cookies and how they are managed.

change_line_mode method (WSClient Struct)

This method controls whether the struct will fire DataIn for each line received.

Syntax

fn change_line_mode(&self, line_mode : bool) -> Result<(), IPWorksSSLError>

Remarks

When line_mode is set to False (default), the component will fire the on_data_in event once for each message received from the server. When line_mode is set to True, the component will instead fire on_data_in for each line of data received. The maximum length of a line can be controlled by the MaxLineLength configuration setting.

NOTE: This method is offered as a convenience feature and has no effect on the behavior of the WebSocket protocol.

config method (WSClient Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksSSLError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

connect method (WSClient Struct)

This method connects to the host specified by the URL property.

Syntax

fn connect(&self) -> Result<(), IPWorksSSLError>

Remarks

The connect method will establish a WebSocket connection to the host and port specified in the url property. The URL must be specified in the format "ws://host:[port]/[URI]" for plaintext connections or "wss://host:[port]/[URI]" for Secure Socket Layer (SSL)-enabled connections.

connect_to method (WSClient Struct)

This method connects to the specified host.

Syntax

fn connect_to(&self, url : &str) -> Result<(), IPWorksSSLError>

Remarks

The connect method will establish a WebSocket connection to the host and port specified in the url parameter. The URL must be specified in the format "ws://host:[port]/[URI]" for plaintext connections or "wss://host:[port]/[URI]" for Secure Sockets Layer (SSL)-enabled connections.

disconnect method (WSClient Struct)

This method disconnects from the remote host.

Syntax

fn disconnect(&self) -> Result<(), IPWorksSSLError>

Remarks

This method disconnects from the remote host.

do_events method (WSClient Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksSSLError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

interrupt method (WSClient Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksSSLError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

pause_data method (WSClient Struct)

This method pauses data reception.

Syntax

fn pause_data(&self) -> Result<(), IPWorksSSLError>

Remarks

This method pauses data reception when called. While data reception is paused, the on_data_in event will not fire. Call process_data to reenable data reception.

ping method (WSClient Struct)

This method sends a ping request to the remote host.

Syntax

fn ping(&self) -> Result<(), IPWorksSSLError>

Remarks

This method sends a ping request to the remote host and waits for a corresponding pong response.

The timeout property specifies how long to wait for the pong response.

process_data method (WSClient Struct)

This method reenables data reception after a call to PauseData .

Syntax

fn process_data(&self) -> Result<(), IPWorksSSLError>

Remarks

This method reenables data reception after a previous call to pause_data. When pause_data is called, the on_data_in event will not fire. To reenable data reception and allow on_data_in to fire, call this method.

NOTE: This method is used only after previously calling pause_data. It does not need to be called to process incoming data by default.

reset method (WSClient Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksSSLError>

Remarks

This method will reset the struct's properties to their default values.

reset_headers method (WSClient Struct)

This method resets all HTTP headers, cookies, LocalFile , and AttachedFile .

Syntax

fn reset_headers(&self) -> Result<(), IPWorksSSLError>

Remarks

This method resets all the HTTP headers as well as local_file and attached_file to "" (empty string). It also resets the cookie properties. Use this method before creating a new request to ensure that headers from the previous message are not carried over to the next one.

send method (WSClient Struct)

This method sends data to the remote host.

Syntax

fn send(&self, data : &[u8]) -> Result<(), IPWorksSSLError>

Remarks

This method sends data to the remote host.

send_bytes method (WSClient Struct)

This method sends data to the remote host.

Syntax

fn send_bytes(&self, data : &[u8]) -> Result<(), IPWorksSSLError>

Remarks

This method sends data to the remote host. Calling this method is equivalent to calling the send_bytes/send_text method.

send_file method (WSClient Struct)

This method sends a file to the remote host.

Syntax

fn send_file(&self, file_name : &str) -> Result<(), IPWorksSSLError>

Remarks

This method sends the specified file to the remote host.

This method requires timeout be set to a positive value. This allows the struct to ensure that the file is transferred completely without a WOULDBLOCK error. See timeout for details.

send_text method (WSClient Struct)

This method sends text data to the server.

Syntax

fn send_text(&self, text : &str) -> Result<(), IPWorksSSLError>

Remarks

This method sends data as text to the server. Data sent with this method will always be treated as text data regardless of the value of data_format. The struct will UTF-8 encode the supplied text.

on_connected event (WSClient Struct)

This event is fired immediately after the WebSocket handshake completes (or fails).

Syntax

// WSClientConnectedEventArgs carries the WSClient Connected event's parameters.
pub struct WSClientConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// WSClientConnectedEvent defines the signature of the WSClient Connected event's handler function.
pub trait WSClientConnectedEvent {
  fn on_connected(&self, sender : WSClient, e : &mut WSClientConnectedEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_connected(&self) -> &'a dyn WSClientConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn WSClientConnectedEvent);
  ...
}

Remarks

The on_connected event will fire after the entire WebSocket connection and handshake process finishes (or fails). This consists of three steps: (1) the initial TCP connection (along with SSL negotiation, if used), (2) the HTTP "Upgrade" request, and (3) the 101 HTTP response.

If the connection is made normally, status_code is 0 and description is "OK".

If the connection fails, status_code has the error code returned by the TCP/IP stack. description contains a description of this code. The value of status_code is equal to the value of the error.

NOTE: Please refer to the Error Codes section for more information.

on_connection_status event (WSClient Struct)

This event is fired to indicate changes in connection state.

Syntax

// WSClientConnectionStatusEventArgs carries the WSClient ConnectionStatus event's parameters.
pub struct WSClientConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// WSClientConnectionStatusEvent defines the signature of the WSClient ConnectionStatus event's handler function.
pub trait WSClientConnectionStatusEvent {
  fn on_connection_status(&self, sender : WSClient, e : &mut WSClientConnectionStatusEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_connection_status(&self) -> &'a dyn WSClientConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn WSClientConnectionStatusEvent);
  ...
}

Remarks

The on_connection_status event is fired when the connection state changes, such as completion of a firewall or proxy connection or completion of a security handshake.

The connection_event parameter indicates the type of connection event. Values may include the following:

on_data_in event (WSClient Struct)

This event is fired when data are received.

Syntax

// WSClientDataInEventArgs carries the WSClient DataIn event's parameters.
pub struct WSClientDataInEventArgs {
  fn data_format(&self) -> i32
  fn text(&self) -> &[u8]
  fn eom(&self) -> bool
  fn eol(&self) -> bool
}

// WSClientDataInEvent defines the signature of the WSClient DataIn event's handler function.
pub trait WSClientDataInEvent {
  fn on_data_in(&self, sender : WSClient, e : &mut WSClientDataInEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_data_in(&self) -> &'a dyn WSClientDataInEvent;
  pub fn set_on_data_in(&mut self, value : &'a dyn WSClientDataInEvent);
  ...
}

Remarks

The on_data_in event provides the data received from the remote host.

The incoming data are provided through the Text parameter.

The DataFormat parameter identifies the encoding (if any) of the data. Possible value are as follows:

The EOM parameter stands for End of Message. By default, the struct will fire the on_data_in event as data are received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is True within the event, this indicates the current fragment is also the final fragment of the message. The struct may also be configured to buffer the message internally until the complete message is received. To enable this, set BufferMessage to True.

The EOL parameter stands for End of Line. When line_mode is False, EOL will always be False. When line_mode is True, EOL will be True if the on_data_in event fired because an EOL was received and will be False if the on_data_in event fired because MaxLineLength was reached.

on_disconnected event (WSClient Struct)

Fired when a connection is closed.

Syntax

// WSClientDisconnectedEventArgs carries the WSClient Disconnected event's parameters.
pub struct WSClientDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// WSClientDisconnectedEvent defines the signature of the WSClient Disconnected event's handler function.
pub trait WSClientDisconnectedEvent {
  fn on_disconnected(&self, sender : WSClient, e : &mut WSClientDisconnectedEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_disconnected(&self) -> &'a dyn WSClientDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn WSClientDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0 and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. description contains a description of this code. The value of status_code is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_error event (WSClient Struct)

Fired when information is available about errors during data delivery.

Syntax

// WSClientErrorEventArgs carries the WSClient Error event's parameters.
pub struct WSClientErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// WSClientErrorEvent defines the signature of the WSClient Error event's handler function.
pub trait WSClientErrorEvent {
  fn on_error(&self, sender : WSClient, e : &mut WSClientErrorEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_error(&self) -> &'a dyn WSClientErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn WSClientErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header event (WSClient Struct)

Fired every time a header line comes in.

Syntax

// WSClientHeaderEventArgs carries the WSClient Header event's parameters.
pub struct WSClientHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// WSClientHeaderEvent defines the signature of the WSClient Header event's handler function.
pub trait WSClientHeaderEvent {
  fn on_header(&self, sender : WSClient, e : &mut WSClientHeaderEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_header(&self) -> &'a dyn WSClientHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn WSClientHeaderEvent);
  ...
}

Remarks

The field parameter contains the name of the HTTP header (which is the same as it is delivered). The value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the field parameter contains "" (empty string).

on_log event (WSClient Struct)

This event fires once for each log message.

Syntax

// WSClientLogEventArgs carries the WSClient Log event's parameters.
pub struct WSClientLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// WSClientLogEvent defines the signature of the WSClient Log event's handler function.
pub trait WSClientLogEvent {
  fn on_log(&self, sender : WSClient, e : &mut WSClientLogEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_log(&self) -> &'a dyn WSClientLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn WSClientLogEvent);
  ...
}

Remarks

This event fires once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.

The value 2 (Verbose) logs additional information about the initial HTTP request.

The value 3 (Debug) logs additional debug information (if available).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "Error"
• "Verbose"
• "Debug"

on_ping event (WSClient Struct)

This event is fired when a ping request or response is received.

Syntax

// WSClientPingEventArgs carries the WSClient Ping event's parameters.
pub struct WSClientPingEventArgs {
  fn payload(&self) -> &[u8]
  fn response(&self) -> bool
}

// WSClientPingEvent defines the signature of the WSClient Ping event's handler function.
pub trait WSClientPingEvent {
  fn on_ping(&self, sender : WSClient, e : &mut WSClientPingEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_ping(&self) -> &'a dyn WSClientPingEvent;
  pub fn set_on_ping(&mut self, value : &'a dyn WSClientPingEvent);
  ...
}

Remarks

This event fires when a ping request or response is received. This event is informational only. When the struct receives a ping request, it will automatically reply with a pong.

payload holds the payload of the request, if any.

response is true if the incoming packet is a ping response. If the incoming packet is a ping request, this is false.

on_ready_to_send event (WSClient Struct)

This event is fired when the struct is ready to send data.

Syntax

// WSClientReadyToSendEventArgs carries the WSClient ReadyToSend event's parameters.
pub struct WSClientReadyToSendEventArgs {
}

// WSClientReadyToSendEvent defines the signature of the WSClient ReadyToSend event's handler function.
pub trait WSClientReadyToSendEvent {
  fn on_ready_to_send(&self, sender : WSClient, e : &mut WSClientReadyToSendEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn WSClientReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn WSClientReadyToSendEvent);
  ...
}

Remarks

The on_ready_to_send event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed send_bytes. This event also is fired immediately after a connection to the remote host is established.

on_redirect event (WSClient Struct)

Fired when a redirection is received from the server.

Syntax

// WSClientRedirectEventArgs carries the WSClient Redirect event's parameters.
pub struct WSClientRedirectEventArgs {
  fn location(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// WSClientRedirectEvent defines the signature of the WSClient Redirect event's handler function.
pub trait WSClientRedirectEvent {
  fn on_redirect(&self, sender : WSClient, e : &mut WSClientRedirectEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_redirect(&self) -> &'a dyn WSClientRedirectEvent;
  pub fn set_on_redirect(&mut self, value : &'a dyn WSClientRedirectEvent);
  ...
}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The accept parameter is always True by default, but if you do not want to follow the redirection, accept may be set to False, in which case the struct fails with an error. location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie event (WSClient Struct)

Fired for every cookie set by the server.

Syntax

// WSClientSetCookieEventArgs carries the WSClient SetCookie event's parameters.
pub struct WSClientSetCookieEventArgs {
  fn name(&self) -> &String
  fn value(&self) -> &String
  fn expires(&self) -> &String
  fn domain(&self) -> &String
  fn path(&self) -> &String
  fn secure(&self) -> bool
}

// WSClientSetCookieEvent defines the signature of the WSClient SetCookie event's handler function.
pub trait WSClientSetCookieEvent {
  fn on_set_cookie(&self, sender : WSClient, e : &mut WSClientSetCookieEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_set_cookie(&self) -> &'a dyn WSClientSetCookieEvent;
  pub fn set_on_set_cookie(&mut self, value : &'a dyn WSClientSetCookieEvent);
  ...
}

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The name parameter contains the name of the cookie, with the corresponding value supplied in the value parameter.

The expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication event (WSClient Struct)

Fired after the server presents its certificate to the client.

Syntax

// WSClientSSLServerAuthenticationEventArgs carries the WSClient SSLServerAuthentication event's parameters.
pub struct WSClientSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// WSClientSSLServerAuthenticationEvent defines the signature of the WSClient SSLServerAuthentication event's handler function.
pub trait WSClientSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : WSClient, e : &mut WSClientSSLServerAuthenticationEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn WSClientSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn WSClientSSLServerAuthenticationEvent);
  ...
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When accept is False, status shows why the verification failed (otherwise, status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the accept parameter to True.

on_ssl_status event (WSClient Struct)

Fired when secure connection progress messages are available.

Syntax

// WSClientSSLStatusEventArgs carries the WSClient SSLStatus event's parameters.
pub struct WSClientSSLStatusEventArgs {
  fn message(&self) -> &String
}

// WSClientSSLStatusEvent defines the signature of the WSClient SSLStatus event's handler function.
pub trait WSClientSSLStatusEvent {
  fn on_ssl_status(&self, sender : WSClient, e : &mut WSClientSSLStatusEventArgs);
}

impl <'a> WSClient<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn WSClientSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn WSClientSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (WSClient Struct)

WebSocket Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (WSClient Struct)

WebSocket Errors

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

SSLClient Errors

SSL Errors

TCP/IP Errors