Struct ipworksssl::WSServer

Properties   Methods   Events   Config Settings   Errors  

The WSServer struct is used to create a WebSocket server.

Syntax

ipworksssl::WSServer

Remarks

The WSServer struct functions as a server that facilitates incoming WebSocket connections and offers a convenient means of transmitting and receiving data over the established connections.

To start, the local_port property must be specified to a valid port. This port will be used to accept incoming connections. Then, call the start_listening method to start listening on the specified port. The WSServer struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method. The SSLCert properties are used to select a certificate for the server.

NOTE: A valid certificate must be selected before the server can function.

Upon a client's connection, the on_web_socket_open_request event will be fired. To accept the connection, simply allow the event to complete its execution. Conversely, to reject the request, the StatusCode parameter can be set to an appropriate HTTP error code, such as 401.

By default, each instance of WSServer has the capacity to handle up to 1,000 simultaneous incoming connections. You can change the maximum number of simultaneous connections by adjusting the MaxConnections configuration setting. This setting allows you to increase the limit up to 100,000 or decrease it to a lower value based on your needs.

Each connection is identified by a unique ConnectionId, an identifier generated by the component to distinguish individual connections. The ConnectionId is also included as a parameter in WSServer's events to identify the associated connection.

After receiving a connection, incoming data can be accessed through the DataIn event. To transmit data to a client, the send, send_text, or send_file methods can be employed.

NOTE: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, do_events should be called in a loop after the server is started.

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 WSServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of WSServer 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.

connection_backlog property (WSServer Struct)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

fn connection_backlog(&self ) -> Result<i32, IPWorksSSLError> 
fn set_connection_backlog(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Data Type

i32

ws_connection_count property (WSServer Struct)

The number of records in the WSConnection arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• ws_connection_accept_data
• ws_connection_bytes_sent
• ws_connection_connected
• ws_connection_connection_id
• ws_connection_data_format
• ws_connection_host
• ws_connection_line_mode
• ws_connection_local_address
• ws_connection_origin
• ws_connection_ready_to_send
• ws_connection_remote_host
• ws_connection_remote_port
• ws_connection_request_headers
• ws_connection_request_uri
• ws_connection_sub_protocols
• ws_connection_timeout

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

This property is read-only.

Data Type

i32

ws_connection_accept_data property (WSServer Struct)

This property indicates whether data reception is currently enabled.

Syntax

fn ws_connection_accept_data(&self , ConnectionId : i32) -> 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 for the connection. Use the pause_data and process_data methods to pause and resume data reception.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

bool

ws_connection_bytes_sent property (WSServer Struct)

This property shows how many bytes were sent after calling Send or SendBytes .

Syntax

fn ws_connection_bytes_sent(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property shows how many bytes were sent after calling send or send_bytes. Please see send or send_bytes for more information.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

i32

ws_connection_connected property (WSServer Struct)

This property indicates the status of individual connections.

Syntax

fn ws_connection_connected(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the disconnect method to disconnect an existing connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

bool

ws_connection_connection_id property (WSServer Struct)

This property contains an identifier generated by the struct to identify each connection.

Syntax

fn ws_connection_connection_id(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property contains an identifier generated by the struct to identify each connection. This identifier is unique to this connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

i32

ws_connection_data_format property (WSServer Struct)

This property includes the format of the data being sent.

Syntax

fn ws_connection_data_format(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 
fn set_ws_connection_data_format(&self, ConnectionId : i32, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

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

Default Value

0

Remarks

This property includes the format of the data being sent. When data are sent over an established connection, it is either considered as text or binary data. Text data are UTF-8 encoded. Binary data have no encoding associated with it.

Possible values are as follows:

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

Data Type

i32

ws_connection_host property (WSServer Struct)

This property includes the Host header value of the connected client.

Syntax

fn ws_connection_host(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property includes the Host header value of the connected client.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_line_mode property (WSServer Struct)

When LineMode is False (default), the struct will fire the DataIn event once for each message received from the server.

Syntax

fn ws_connection_line_mode(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

When ws_connection_line_mode is False (default), the component will fire the on_data_in event once for each message received from the server. When ws_connection_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 property is read-only and should be set through the change_line_mode method.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

bool

ws_connection_local_address property (WSServer Struct)

This property shows the IP address of the interface through which the connection is passing.

Syntax

fn ws_connection_local_address(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property shows the IP address of the interface through which the connection is passing.

ws_connection_local_address is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_origin property (WSServer Struct)

This property includes the origin header value of the connected client.

Syntax

fn ws_connection_origin(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property includes the origin header value of the connected client.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_ready_to_send property (WSServer Struct)

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

Syntax

fn ws_connection_ready_to_send(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

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

This is true after a client connects but will become false after a failed call to send or send_bytes. After a failed call to send or send_bytes, the on_ready_to_send event will fire and this property will be true when data can be sent again.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

bool

ws_connection_remote_host property (WSServer Struct)

This property shows the IP address of the connected client.

Syntax

fn ws_connection_remote_host(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property shows the IP address of the connected client.

The connection must be valid or an error will be fired.

If the struct is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_remote_port property (WSServer Struct)

This property shows the port of the connected client.

Syntax

fn ws_connection_remote_port(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property shows the port of the connected client.

The connection must be valid or an error will be fired.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

i32

ws_connection_request_headers property (WSServer Struct)

The HTTP headers sent by the client in the initial WebSocket connection request.

Syntax

fn ws_connection_request_headers(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The HTTP headers sent by the client in the initial WebSocket connection request.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_request_uri property (WSServer Struct)

This property includes the requested URI sent by the client in the initial WebSocket connection request.

Syntax

fn ws_connection_request_uri(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property includes the requested URI sent by the client in the initial WebSocket connection request.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_sub_protocols property (WSServer Struct)

This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

Syntax

fn ws_connection_sub_protocols(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only.

Data Type

String

ws_connection_timeout property (WSServer Struct)

This property specifies a timeout for the struct.

Syntax

fn ws_connection_timeout(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 
fn set_ws_connection_timeout(&self, ConnectionId : i32, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property specifies a timeout for the struct.

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

If ws_connection_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 ws_connection_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 ws_connection_timeout property is 0 (asynchronous operation).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

Data Type

i32

default_timeout property (WSServer Struct)

This property includes initial timeout value to be used by incoming connections.

Syntax

fn default_timeout(&self ) -> Result<i32, IPWorksSSLError> 
fn set_default_timeout(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property is used by the struct to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

i32

listening property (WSServer Struct)

This property indicates whether the struct is listening for incoming connections on LocalPort.

Syntax

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

Default Value

false

Remarks

This property indicates whether the struct is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the struct is listening.

This property is read-only.

Data Type

bool

local_host property (WSServer 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 (WSServer Struct)

This property includes the Transmission Control Protocol (TCP) port in the local host where the struct listens.

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 the struct can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the struct is listening (i.e., after successfully assigning True to the listening property).

The service port is not shared among servers so two structs cannot be listening on the same port at the same time.

Data Type

i32

ssl_authenticate_clients property (WSServer Struct)

If set to True, the server asks the client(s) for a certificate.

Syntax

fn ssl_authenticate_clients(&self ) -> Result<bool, IPWorksSSLError> 
fn set_ssl_authenticate_clients(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

Data Type

bool

ssl_cert_effective_date property (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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 (WSServer 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

change_line_mode method (WSServer Struct)

This method controls whether the struct will fire DataIn when an EOL is received for the specified connection.

Syntax

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

Remarks

When ws_connection_line_mode is set to False (default), the component will fire the on_data_in event once for each message received from the client. When LineMode 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[ConnectionId]; configuration setting.

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

config method (WSServer 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.

disconnect method (WSServer Struct)

This method disconnects the specified client.

Syntax

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

Remarks

Calling this method will disconnect the client specified by the connection_id parameter.

do_events method (WSServer 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 (WSServer Struct)

This method interrupts a synchronous send to the remote host.

Syntax

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

Remarks

This property is called using the ConnectionId if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the struct. If you use send_file to upload a file, the struct will run synchronously on that ConnectionId until it is completed.

ping method (WSServer Struct)

This method sends a ping request to the remote host.

Syntax

fn ping(&self, connection_id : i32) -> 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.

send method (WSServer Struct)

This method sends binary data to the client.

Syntax

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

Remarks

This method sends the binary data specified by Data to the client specified by ConnectionId.

send_bytes method (WSServer Struct)

This method sends binary data to the specified client.

Syntax

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

Remarks

This method sends binary data to the client identified by connection_id. To send text, use the send_text method instead.

When ws_connection_timeout is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.

NOTE: The on_ready_to_send event is not fired when part of the data is sent successfully.

send_file method (WSServer Struct)

This method sends the file to the remote host.

Syntax

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

Remarks

This method sends the file to the client specified by the connection_id.

send_text method (WSServer Struct)

This method sends text data to the client.

Syntax

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

Remarks

This method sends text to the client identified by connection_id. To send binary data, use the send_bytes method instead.

When ws_connection_timeout is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.

NOTE: The on_ready_to_send event is not fired when part of the data is sent successfully.

This method sends text to the client identified by ConnectionId. Data sent with this method will always be treated as text data regardless of the value of ws_connection_data_format. The struct will UTF-8 encode the supplied text.

shutdown method (WSServer Struct)

This method shuts down the server.

Syntax

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

Remarks

This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.

start_listening method (WSServer Struct)

This method starts listening for incoming connections.

Syntax

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

Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

stop_listening method (WSServer Struct)

This method stops listening for new connections.

Syntax

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

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call shutdown instead.

on_connected event (WSServer Struct)

This event is fired when a WebSocket is successfully opened.

Syntax

// WSServerConnectedEventArgs carries the WSServer Connected event's parameters.
pub struct WSServerConnectedEventArgs {
  fn connection_id(&self) -> i32
}

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

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

Remarks

The on_connected event is fired when a WebSocket is successfully opened on a connection.

ConnectionId identifies the connection.

on_connection_request event (WSServer Struct)

This event is fired when a request for connection comes from a remote host.

Syntax

// WSServerConnectionRequestEventArgs carries the WSServer ConnectionRequest event's parameters.
pub struct WSServerConnectionRequestEventArgs {
  fn address(&self) -> &String
  fn port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// WSServerConnectionRequestEvent defines the signature of the WSServer ConnectionRequest event's handler function.
pub trait WSServerConnectionRequestEvent {
  fn on_connection_request(&self, sender : WSServer, e : &mut WSServerConnectionRequestEventArgs);
}

impl <'a> WSServer<'a> {
  pub fn on_connection_request(&self) -> &'a dyn WSServerConnectionRequestEvent;
  pub fn set_on_connection_request(&mut self, value : &'a dyn WSServerConnectionRequestEvent);
  ...
}

Remarks

This event indicates an incoming connection. The connection is accepted by default. address and port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the accept parameter to False.

on_data_in event (WSServer Struct)

This event is fired when data are received.

Syntax

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

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

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

Remarks

The on_data_in event provides the data received from the client identified by the ConnectionId parameter.

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 (WSServer Struct)

This event is fired when a WebSocket connection is disconnected.

Syntax

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

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

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

Remarks

When the connection is closed the StatusCode parameter may be used to determine if the disconnect occurred normally or if there was an error condition. If the connection is closed normally, the StatusCode will be 1000. The Description parameter will contain a textual description returned by the server. Common StatusCode values are as follows:

on_error event (WSServer Struct)

This event is fired for information about errors during data delivery.

Syntax

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

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

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

Remarks

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

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

ErrorCode contains an error code and Description 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_log event (WSServer Struct)

This event fires once for each log message.

Syntax

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

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

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

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 (WSServer Struct)

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

Syntax

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

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

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

Remarks

This event fires when a ping request or response is received from the client identified by the connection_id parameter. 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 (WSServer Struct)

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

Syntax

// WSServerReadyToSendEventArgs carries the WSServer ReadyToSend event's parameters.
pub struct WSServerReadyToSendEventArgs {
  fn connection_id(&self) -> i32
}

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

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

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. This event is also fired immediately after a connection is established.

on_ssl_client_authentication event (WSServer Struct)

This event is fired when the client presents its credentials to the server.

Syntax

// WSServerSSLClientAuthenticationEventArgs carries the WSServer SSLClientAuthentication event's parameters.
pub struct WSServerSSLClientAuthenticationEventArgs {
  fn connection_id(&self) -> i32
  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)
}

// WSServerSSLClientAuthenticationEvent defines the signature of the WSServer SSLClientAuthentication event's handler function.
pub trait WSServerSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : WSServer, e : &mut WSServerSSLClientAuthenticationEventArgs);
}

impl <'a> WSServer<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn WSServerSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn WSServerSSLClientAuthenticationEvent);
  ...
}

Remarks

This event enables the server to decide whether or not to continue. The accept parameter is a recommendation on whether to continue or to 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").

on_ssl_connection_request event (WSServer Struct)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

// WSServerSSLConnectionRequestEventArgs carries the WSServer SSLConnectionRequest event's parameters.
pub struct WSServerSSLConnectionRequestEventArgs {
  fn connection_id(&self) -> i32
  fn supported_cipher_suites(&self) -> &String
  fn supported_signature_algs(&self) -> &String
  fn cert_store_type(&self) -> i32
  fn set_cert_store_type(&self, value : i32)
  fn cert_store(&self) -> &String
  fn set_cert_store(&self, value : &str)
  fn set_cert_store_ref(&self, value : &String)
  fn cert_password(&self) -> &String
  fn set_cert_password(&self, value : &str)
  fn set_cert_password_ref(&self, value : &String)
  fn cert_subject(&self) -> &String
  fn set_cert_subject(&self, value : &str)
  fn set_cert_subject_ref(&self, value : &String)
}

// WSServerSSLConnectionRequestEvent defines the signature of the WSServer SSLConnectionRequest event's handler function.
pub trait WSServerSSLConnectionRequestEvent {
  fn on_ssl_connection_request(&self, sender : WSServer, e : &mut WSServerSSLConnectionRequestEventArgs);
}

impl <'a> WSServer<'a> {
  pub fn on_ssl_connection_request(&self) -> &'a dyn WSServerSSLConnectionRequestEvent;
  pub fn set_on_ssl_connection_request(&mut self, value : &'a dyn WSServerSSLConnectionRequestEvent);
  ...
}

Remarks

This event fires when an SSL connection is requested and ssl_provider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when ssl_provider is set to Platform.

This event allows the struct to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

connection_id is the connection Id of the client requesting the connection.

supported_cipher_suites is a comma-separated list of cipher suites that the client supports.

supported_signature_algs is a comma-separated list of certificate signature algorithms that the client supports.

cert_store_type is the store type of the alternate certificate to use for this connection. 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:

cert_store is the store name or location of the alternate certificate to use for this connection.

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

cert_password is the password of the certificate store containing the alternate certificate to use for this connection.

cert_subject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the 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.

on_ssl_status event (WSServer Struct)

This event is fired to show the progress of the secure connection.

Syntax

// WSServerSSLStatusEventArgs carries the WSServer SSLStatus event's parameters.
pub struct WSServerSSLStatusEventArgs {
  fn connection_id(&self) -> i32
  fn message(&self) -> &String
}

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

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

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

on_web_socket_open_request event (WSServer Struct)

This event is fired when a client attempts to open a WebSocket.

Syntax

// WSServerWebSocketOpenRequestEventArgs carries the WSServer WebSocketOpenRequest event's parameters.
pub struct WSServerWebSocketOpenRequestEventArgs {
  fn connection_id(&self) -> i32
  fn request_uri(&self) -> &String
  fn host_header(&self) -> &String
  fn origin_header(&self) -> &String
  fn sub_protocols(&self) -> &String
  fn set_sub_protocols(&self, value : &str)
  fn set_sub_protocols_ref(&self, value : &String)
  fn extensions(&self) -> &String
  fn request_headers(&self) -> &String
  fn status_code(&self) -> i32
  fn set_status_code(&self, value : i32)
  fn response_headers(&self) -> &String
  fn set_response_headers(&self, value : &str)
  fn set_response_headers_ref(&self, value : &String)
}

// WSServerWebSocketOpenRequestEvent defines the signature of the WSServer WebSocketOpenRequest event's handler function.
pub trait WSServerWebSocketOpenRequestEvent {
  fn on_web_socket_open_request(&self, sender : WSServer, e : &mut WSServerWebSocketOpenRequestEventArgs);
}

impl <'a> WSServer<'a> {
  pub fn on_web_socket_open_request(&self) -> &'a dyn WSServerWebSocketOpenRequestEvent;
  pub fn set_on_web_socket_open_request(&mut self, value : &'a dyn WSServerWebSocketOpenRequestEvent);
  ...
}

Remarks

This event fires when a client connects. It provides an opportunity to inspect the WebSocket request and either accept or reject the connection attempt.

By default, the struct will accept the connection. You do not need to set anything to accept the connection. The struct will return a StatusCode of 101 to the connecting client, and the request will proceed as normal. To reject a connection, set StatusCode to an HTTP error code, such as 401.

ConnectionId identifies the connecting client.

RequestURI provides the URI requested by the connecting client. This may be used to implement logic to select appropriate SubProtocols or to determine if the connection should be accepted based on access restrictions to the URI.

HostHeader holds the value of the Host header sent by the client.

OriginHeader holds the value of the Origin header sent by the client.

SubProtocols holds a comma-separated list of subprotocols sent by the client (if any). Set SubProtocols to the selected value from the list sent by the client. The struct will return this value to the client as the subprotocol the server has selected.

Extensions provides a list of extensions supported by the client.

RequestHeaders contains the HTTP headers sent in the request by the connecting client.

StatusCode determines success or failure. The value 101 (default) indicates success. This may be set to any HTTP status code. For instance, a value of 401 indicates an authorization failure.

ResponseHeaders may be set to include additional headers in the response. This is typically used when rejecting a request. For instance when StatusCode is set to 401, you might set ResponseHeaders to "WWW-Authenticate: Basic realm="Secure Realm"" to request authorization from the connecting client.

Config Settings (WSServer Struct)

WebSocketServer Config Settings

TCPServer 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-----

Base Config Settings

Trappable Errors (WSServer Struct)

WSServer Errors

SSLServer Errors

SSL Errors

TCP/IP Errors