Struct ipworks::XMPP

Properties   Methods   Events   Config Settings   Errors  

The XMPP Struct is used to create a lightweight messaging client using the XMPP (Jabber) protocol.

Syntax

ipworks::XMPP

Remarks

The XMPP struct supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL-related settings are also supported through the config method.

A call to the connect_to method will perform the entire logon process after which a on_connected event will fire to indicate the connection status. For simplicity, the entire interface is synchronous; the struct will not return until a call is completed.

After a successful connection, the struct will automatically begin the process of receiving the user's buddy list. The struct will parse the XML as it comes in from the server and will set the appropriate properties. Once the entire buddy list has been retrieved, a on_sync event will fire.

Sending a message is as simple as calling a single method. One call to the send_message method will cause the struct to connect if it has not already done so, send the specified message to a specified user, and return to the original connection state.

The XMPP Struct interface supports messaging, list, and presence management. Other features of the XMPP protocol are supported through the send_command method and on_pi_trail event.

Example 1. Connecting and Sending a Message:

IMControl.ConnectTo("myusername", "mypassword") IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser") Example 2. Sending a Single Message:

IMControl.User = "myusername" IMControl.Password = "mypassword" IMControl.MessageText = "My Message" IMControl.SendMessage("ToUser")

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the XMPP struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of XMPP 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.

auth_domain property (XMPP Struct)

This property includes the domain under which the user will be authenticated.

Syntax

fn auth_domain(&self ) -> Result<String, IPWorksError> 
fn set_auth_domain(&self, value : &str) ->  Option<IPWorksError> 
fn set_auth_domain_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

Set this value if the user must authenticate through a third-party authentication service that requires a different domain than the XMPP user's registered domain.

Data Type

String

auth_methods property (XMPP Struct)

This property controls how the struct authenticates itself with the XMPP server.

Syntax

fn auth_methods(&self ) -> Result<String, IPWorksError> 
fn set_auth_methods(&self, value : &str) ->  Option<IPWorksError> 
fn set_auth_methods_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

"*"

Remarks

auth_methods is a comma-separated list of authentication methods to be enabled on the struct, listed in order of preference. When authenticating, the struct will pick the first method in the list that is supported by the server.

The special value * (default) may be supplied to cause the struct to enable all supported authentication methods in order of presumed security. The XMPP struct currently supports the following values for auth_methods, listed in order of most secure to least secure:

• SASL/DIGEST-MD5
• AuthIQ/Digest
• SASL/CRAM-MD5
• SASL/PLAIN
• AuthIQ/Plaintext
• SASL/NTLM

Data Type

String

buddy_count property (XMPP Struct)

The number of records in the Buddy arrays.

Syntax

fn buddy_count(&self ) -> Result<i32, IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• buddy_group
• buddy_id
• buddy_nick_name
• buddy_real_name
• buddy_subscription

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

This property is read-only.

Data Type

i32

buddy_group property (XMPP Struct)

This property holds a comma-separated list of the buddy's associated groups.

Syntax

fn buddy_group(&self , BuddyIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property holds a comma-separated list of the buddy's associated groups.

After the on_sync event has fired, this property will contain a comma-separated list of groups for the associated buddy_id. Call the update_buddy_group method to update the buddy's group associations.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only.

Data Type

String

buddy_id property (XMPP Struct)

This property is the jabber Id of the buddy.

Syntax

fn buddy_id(&self , BuddyIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property is the jabber Id of the buddy.

After a on_sync event is fired, this property will contain the user Id associated with the corresponding entry in the buddy list. If a buddy has multiple entries (e.g., if the buddy is listed in several groups), more than one entry will be the same.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only.

Data Type

String

buddy_nick_name property (XMPP Struct)

This property includes the nickname of the buddy, if one exists.

Syntax

fn buddy_nick_name(&self , BuddyIndex : i32) -> Result<String, IPWorksError> 
fn set_buddy_nick_name(&self, BuddyIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_buddy_nick_name_ref(&self, BuddyIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property includes the nickname of the buddy, if one exists.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

Data Type

String

buddy_real_name property (XMPP Struct)

This property includes the real name of the buddy.

Syntax

fn buddy_real_name(&self , BuddyIndex : i32) -> Result<String, IPWorksError> 

Default Value

""

Remarks

This property includes the real name of the buddy.

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only.

Data Type

String

buddy_subscription property (XMPP Struct)

This property includes a list of the buddy's subscription status types.

Syntax

fn buddy_subscription(&self , BuddyIndex : i32) -> Result<i32, IPWorksError> 

Possible Values

0   // None
1   // To
2   // From
3   // Both
4   // Remove

Default Value

0

Remarks

This property includes a list of the buddy's subscription status types.

After a on_sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:

The BuddyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BuddyCount property.

This property is read-only.

Data Type

i32

connected property (XMPP Struct)

This property indicates whether the struct is connected and logged in.

Syntax

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

Default Value

false

Remarks

This property indicates whether the struct is connected and logged in to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

Data Type

bool

firewall_auto_detect property (XMPP Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

firewall_type property (XMPP Struct)

The type of firewall to connect through.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

im_port property (XMPP Struct)

This property includes the server port for XMPP (default 5222).

Syntax

fn im_port(&self ) -> Result<i32, IPWorksError> 
fn set_im_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

5222

Remarks

For an implicit Secure Sockets Layer (SSL), use port 5223. For more information, please refer to the ssl_start_mode property.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

i32

im_server property (XMPP Struct)

This property is the instant messaging server.

Syntax

fn im_server(&self ) -> Result<String, IPWorksError> 
fn set_im_server(&self, value : &str) ->  Option<IPWorksError> 
fn set_im_server_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This is the instant messaging server to which the struct will connect when the connect method is called. The im_server property must contain a valid XMPP (Jabber) server, or any subsequent calls to the connect method will fail.

Data Type

String

local_directory property (XMPP Struct)

This property includes the directory to which received files are saved.

Syntax

fn local_directory(&self ) -> Result<String, IPWorksError> 
fn set_local_directory(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_directory_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property specifies the directory on disk to which received files will be saved. If this property is not set and a file is received, the file data will be available through the on_transfer event parameters. This property may also be set when the on_start_transfer event fires.

Data Type

String

local_file property (XMPP Struct)

This property includes the path to the file that will be sent.

Syntax

fn local_file(&self ) -> Result<String, IPWorksError> 
fn set_local_file(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_file_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property specifies the local file that will be sent when calling send_file. This property must be set before calling send_file.

Data Type

String

local_host property (XMPP 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, IPWorksError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksError> 

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

message_html property (XMPP Struct)

This property includes the HTML version of the current message.

Syntax

fn message_html(&self ) -> Result<String, IPWorksError> 
fn set_message_html(&self, value : &str) ->  Option<IPWorksError> 
fn set_message_html_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

If the user wishes to send any HTML as a part of the message, it must be set in the message_html property. The HTML must be an entire HTML document, including the <html> and <body> tags. If the HTML has unbalanced tags, the XMPP struct will fail with an error.

Data Type

String

message_other_data property (XMPP Struct)

This property contains extra data elements for the current message.

Syntax

fn message_other_data(&self ) -> Result<String, IPWorksError> 
fn set_message_other_data(&self, value : &str) ->  Option<IPWorksError> 
fn set_message_other_data_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

message_other_data will contain zero or more complete XML elements that are associated with the message but that are not defined in the Jabber specification.

Data Type

String

message_subject property (XMPP Struct)

This property is the subject of the current message.

Syntax

fn message_subject(&self ) -> Result<String, IPWorksError> 
fn set_message_subject(&self, value : &str) ->  Option<IPWorksError> 
fn set_message_subject_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

message_subject will contain any subject associated with the message. Most Jabber clients will ignore the subject unless the message is of type "headline".

Data Type

String

message_text property (XMPP Struct)

This property is the plaintext version of the current message.

Syntax

fn message_text(&self ) -> Result<String, IPWorksError> 
fn set_message_text(&self, value : &str) ->  Option<IPWorksError> 
fn set_message_text_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

message_text is the plaintext version of the current message, taken from the message's "body" child element. The text in this property is automatically escaped to ensure valid XML parsing on the other end.

Data Type

String

message_thread property (XMPP Struct)

This property is the thread name of the current message.

Syntax

fn message_thread(&self ) -> Result<String, IPWorksError> 
fn set_message_thread(&self, value : &str) ->  Option<IPWorksError> 
fn set_message_thread_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

message_thread will contain the name of the thread associated with the message. Threads are useful for tracking messages of type "chat" or "groupchat".

Data Type

String

message_type property (XMPP Struct)

This property is the type of the current message.

Syntax

fn message_type(&self ) -> Result<i32, IPWorksError> 
fn set_message_type(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Normal
1   // Chat
2   // GroupChat
3   // Headline
4   // Error

Default Value

0

Remarks

message_type is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:

Data Type

i32

password property (XMPP Struct)

This property is the user's password.

Syntax

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

Default Value

""

Remarks

This property must be set before a connection is attempted. If a call to the connect method is made specifying a password, then the password property will contain that password.

Data Type

String

presence property (XMPP Struct)

This property indicates the availability of the entity.

Syntax

fn presence(&self ) -> Result<i32, IPWorksError> 

Possible Values

0   // Offline
1   // Chat
2   // Away
3   // XA
4   // DND

Default Value

1

Remarks

When the struct completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

The presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

By default, the struct sets the client presence to pcChat, meaning that the user is available.

NOTE: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an on_error.

The status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

If the application or user wishes to associate a specific status message with a new presence value, it should use the change_presence method. change_presence will update both the presence and status properties, and then send that information to the server.

This property is read-only.

Data Type

i32

resource property (XMPP Struct)

This property is the resource for the current session.

Syntax

fn resource(&self ) -> Result<String, IPWorksError> 
fn set_resource(&self, value : &str) ->  Option<IPWorksError> 
fn set_resource_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

"IPWorks XMPP Agent"

Remarks

Whenever an entity logs in to an XMPP (Jabber) server, it must provide account information as well as a resource. Resources allow multiple clients to log in using the same account. The server will forward all messages and PI data aimed at a specific resource to that resource. If a command or message is to be sent to a Jabber Id with no specified resource, the server will push that command or message out to all connected resources.

Data Type

String

server_domain property (XMPP Struct)

This property includes the XMPP server's domain.

Syntax

fn server_domain(&self ) -> Result<String, IPWorksError> 
fn set_server_domain(&self, value : &str) ->  Option<IPWorksError> 
fn set_server_domain_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

The domain of the XMPP server itself. Set this value if the domain of the server is different from the DNS name of the im_server.

Data Type

String

ssl_accept_server_cert_effective_date property (XMPP Struct)

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

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 (XMPP 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, IPWorksError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

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 (XMPP 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, IPWorksError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

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

The certificate (PEM/Base64 encoded).

Syntax

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

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_enabled property (XMPP Struct)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksError> 

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value.

Data Type

bool

ssl_provider property (XMPP Struct)

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

Syntax

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

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

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

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 (XMPP 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, IPWorksError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

ssl_start_mode property (XMPP Struct)

This property determines how the struct starts the Secure Sockets Layer (SSL) negotiation.

Syntax

fn ssl_start_mode(&self ) -> Result<i32, IPWorksError> 
fn set_ssl_start_mode(&self, value : i32) ->  Option<IPWorksError> 

Possible Values

0   // Automatic
1   // Implicit
2   // Explicit
3   // None

Default Value

3

Remarks

The ssl_start_mode property may have one of the following values:

Data Type

i32

status property (XMPP Struct)

This property holds the description of the availability of this entity.

Syntax

fn status(&self ) -> Result<String, IPWorksError> 

Default Value

"Available for Chat."

Remarks

When the struct completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.

The presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:

By default, the struct sets the client presence to pcChat, meaning that the user is available.

NOTE: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an on_error.

The status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".

If the application or user wishes to associate a specific status message with a new presence value, it should use the change_presence method. change_presence will update both the presence and status properties, and then send that information to the server.

This property is read-only.

Data Type

String

timeout property (XMPP Struct)

The timeout for the struct.

Syntax

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

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the struct will wait for the operation to complete before returning control.

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

user property (XMPP Struct)

This property includes the user portion of this entity's Jabber Id.

Syntax

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

Default Value

""

Remarks

The user property is a unique username associated with this entity and is set at the time of registration under the field "user".

Data Type

String

user_domain property (XMPP Struct)

This property gets or sets the domain value used for Jabber Ids.

Syntax

fn user_domain(&self ) -> Result<String, IPWorksError> 
fn set_user_domain(&self, value : &str) ->  Option<IPWorksError> 
fn set_user_domain_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

A Jabber Id (JID) is a unique identifier of the format "user@user_domain/resource". user@domain denotes the account by username and domain. The resource is given during the login process to distinguish individual connections under the same account. If the im_server contains multiple domains, this property setting allows the user to specify the domain under which to log in.

If user_domain is empty, the value in im_server is used by default when creating the client's JID.

Data Type

String

user_info_count property (XMPP Struct)

The number of records in the UserInfo arrays.

Syntax

fn user_info_count(&self ) -> Result<i32, IPWorksError> 
fn set_user_info_count(&self, value : i32) ->  Option<IPWorksError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_info_field
• user_info_value

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

Data Type

i32

user_info_field property (XMPP Struct)

This property includes the name of the current property necessary for registration.

Syntax

fn user_info_field(&self , FieldIndex : i32) -> Result<String, IPWorksError> 
fn set_user_info_field(&self, FieldIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_user_info_field_ref(&self, FieldIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property includes the name of the current property necessary for registration.

Before a registration can be attempted, the application should use the query_register method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the user_info properties accordingly. After a successful query, all entries in user_info values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in user_info, and added any extra fields they may wish to include in their registration, the application should make a call to register.

If the struct is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserInfoCount property.

Data Type

String

user_info_value property (XMPP Struct)

This property includes the value of the current registration property.

Syntax

fn user_info_value(&self , FieldIndex : i32) -> Result<String, IPWorksError> 
fn set_user_info_value(&self, FieldIndex : i32, value : &str) ->  Option<IPWorksError> 
fn set_user_info_value_ref(&self, FieldIndex : i32, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

This property includes the value of the current registration field. It should be set after calling query_register and before calling register.

Before a registration can be attempted, the application should use the query_register method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the user_info properties accordingly. After a successful query, all entries in user_info values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in user_info, and added any extra fields they may wish to include in their registration, the application should make a call to register.

If the struct is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserInfoCount property.

Data Type

String

add method (XMPP Struct)

This method will add an entity to this entity's roster.

Syntax

fn add(&self, jabber_id : &str, name : &str, groups : &str) -> Result<(), IPWorksError>

Remarks

jabber_id is the Jabber Id of the entity to be added. It should be of form "user@host". If no hostname is specified, the struct will assume the user's account is with the server in im_server, and will append that hostname to jabber_id before sending the request.

name will contain the name that is to be associated with jabber_id in this entity's roster. It may be the empty string, "".

groups is either the empty string ("") or a comma- separated list of groups to which the jabber_id is to be added. If jabber_id already exists in the buddy list, it will be updated to exist only in the specified groups. A buddy's group list can also be modified by the buddies property.

The add method will make a subscription request to the presence of the specified jabber_id. Upon receiving this request, the server will add an entry into this user's buddy list with a subscription of type subscriptionNone (0) if there was no previous entry (if this user has already allowed jabber_id to subscribe to this user's presence, there will already be an entry of type subscriptionFrom (2)). If the contact chooses to allow the subscription, the server will update the entry and a on_buddy_update event will fire with the new subscription value (subscriptionTo (1) if this is a new contact, or subscriptionBoth (3) if the contact is now mutual).

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The register method can be used to register with a foreign network gateway.

cancel method (XMPP Struct)

This method will cancel another entity's subscription to this entity's presence.

Syntax

fn cancel(&self, jabber_id : &str) -> Result<(), IPWorksError>

Remarks

If for any reason the user should want to undo a previously granted subscription, this can be achieved through the cancel method. The method will unsubscribe the target from this user's presence, thus preventing the target from seeing this user in the future.

change_password method (XMPP Struct)

This method will change the current user's password.

Syntax

fn change_password(&self, password : &str) -> Result<(), IPWorksError>

Remarks

This method changes the current user's password to the password that is specified. The struct must be connected to the server when this method is called.

change_presence method (XMPP Struct)

This method will set the availability and status of this entity.

Syntax

fn change_presence(&self, presence_code : i32, status : &str) -> Result<(), IPWorksError>

Remarks

presence_code should correspond to the possible values of the presence property:

By default, the struct sets the client presence to pcChat, meaning that the user is available.

NOTE: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an on_error.

status can be any random string, including the empty string "".

config method (XMPP Struct)

Sets or retrieves a configuration setting.

Syntax

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

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

This method will connect the struct to the server.

Syntax

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

Remarks

The connect method performs the entire connection routine. This includes connection to the im_server, authenticating with the specified user and password, and session initialization.

The on_connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

connect_to method (XMPP Struct)

This method will connect the struct to the server.

Syntax

fn connect_to(&self, user : &str, password : &str) -> Result<(), IPWorksError>

Remarks

The connect_to method performs the entire connection routine. This includes connection to the im_server, user logon and authentication, and session initialization.

The on_connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.

Because connect_to is called with a user and password specified, the user and password properties will updated accordingly.

disconnect method (XMPP Struct)

This method disconnects the struct from the server.

Syntax

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

Remarks

The disconnect method will send the disconnect command to the notification server. Upon disconnection, a on_disconnected event will be fired.

do_events method (XMPP Struct)

This method processes events from the internal message queue.

Syntax

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

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

This method interrupts the current method.

Syntax

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

Remarks

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

probe_presence method (XMPP Struct)

Use this method to probe for another entity's presence.

Syntax

fn probe_presence(&self, jabber_id : &str) -> Result<(), IPWorksError>

Remarks

In the case that the user needs to update a particular entity's presence, this method can be used to retrieve it. After a successful call, the server will either respond with the last known presence for Jabber or will send a presence element of type "error". In either case, the respond will be returned by a on_presence event.

query_register method (XMPP Struct)

This method queries a server for the necessary registration fields.

Syntax

fn query_register(&self, xmpp_server : &str) -> Result<(), IPWorksError>

Remarks

Before a registration can be attempted, the application should use the query_register method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the user_info properties accordingly. After a successful query, all entries in user_info values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in user_info, and added any extra fields they may wish to include in their registration, the application should make a call to register.

If the struct is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

register method (XMPP Struct)

This method registers an account with a server.

Syntax

fn register(&self, xmpp_server : &str) -> Result<(), IPWorksError>

Remarks

Before a registration can be attempted, the application should use the query_register method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the user_info properties accordingly. After a successful query, all entries in user_info values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in user_info, and added any extra fields they may wish to include in their registration, the application should make a call to register.

If the struct is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

A new account can be registered at any time, including while the struct is logged into the host under an existing account.

remove method (XMPP Struct)

This method will remove an entity from this entity's roster.

Syntax

fn remove(&self, jabber_id : &str, name : &str, group : &str) -> Result<(), IPWorksError>

Remarks

jabber_id is the Jabber Id of the entity to be removed. It should be in the form of "user@host". If no hostname is specified, the struct will assume the user's account is with the server in im_server, and it will append that hostname to jabber_id before sending the request.

name should contain the name that is to be associated with jabber_id in this entity's roster. It may be the empty string, "".

Groups may be either the empty string ("") or a comma- separated list of groups from which jabber_id is to be removed. If no group is specified, the buddy will be completely removed from the buddy list.

After calling the remove method, the server will remove the entry from the server-side roster and will push the result out to all connected resources. A on_buddy_update event will fire with a subscription of type subscriptionRemove, and the entry will be removed from the Jabber struct's internally stored list.

reset method (XMPP Struct)

This method will reset the struct.

Syntax

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

Remarks

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

retrieve_roster method (XMPP Struct)

This method will retrieve this entity's roster from the server.

Syntax

fn retrieve_roster(&self) -> Result<(), IPWorksError>

Remarks

After the struct connects, it will automatically send a request to the server to retrieve the roster. If, however, the user or application wish to update the entire roster, this method may be used to do so.

After a successful call to the retrieve_roster method, the server will respond with this entity's roster. The struct will parse the roster and fire the on_sync event once per item. This event may also fire for each entity added to or removed from the roster.

send_command method (XMPP Struct)

This method sends a command to the server.

Syntax

fn send_command(&self, command : &str) -> Result<(), IPWorksError>

Remarks

The send_command method will send the command parameter to the server. The command must be in valid XML format and must be recognizable to the im_server.

The send_command method should be used only by programmers or users who are connecting to nonstandard servers whose command list is not covered by the struct. Any responses that are defined in the protocol specification will be returned by the appropriate event. Any nonstandard IQ message will be returned by the on_iq event. All other responses will be returned by the on_pi_trail event.

send_file method (XMPP Struct)

This method sends a file to the specified user.

Syntax

fn send_file(&self, jabber_id : &str) -> Result<(), IPWorksError>

Remarks

This method sends the file specified by local_file to the user specified by the jabber_id parameter.

jabber_id is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

The struct supports sending files using In-Band Bystestreams as defined in XEP-0047 and XEP-0096.

send_message method (XMPP Struct)

This method will send a message to the specified user.

Syntax

fn send_message(&self, jabber_id : &str) ->  Result<String, IPWorksError>

Remarks

jabber_id is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.

The struct associates several properties with messages it receives and sends. When it receives a message, the struct will parse out the corresponding values and set these properties before firing a on_message_in event. After the event returns control to the struct, the properties will be cleared (i.e., they will be set to the empty string, "").

Before sending a message, the application should set the appropriate properties to be associated with the message. The struct will send only properties with nonempty string values ("") and will clear all properties after a successful send.

The associated properties are the following:

If the parameter passed to send_message is prefixed with "@" the component will interpret the value as a domain when constructing the message. This allows for sending directly to subdomains.

NOTE: The XMPP struct will generate and return a unique identifier for each message sent. This identifier can be used to track messages in conjunction with various Jabber Extension Protocols.

set_user_input_field_name method (XMPP Struct)

This method will add a user information field for registration.

Syntax

fn set_user_input_field_name(&self, field : &str, value : &str) -> Result<(), IPWorksError>

Remarks

This method will search through user_info for the field name in field and set the corresponding value to value. If the field was not previously contained in user_info, it will automatically be added.

Before a registration can be attempted, the application should use the query_register method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the user_info properties accordingly. After a successful query, all entries in user_info values will be empty strings.

The possible registration fields are defined in the Jabber protocol specification, as follows:

After the user has set all of the values in user_info, and added any extra fields they may wish to include in their registration, the application should make a call to register.

If the struct is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.

subscribe_to method (XMPP Struct)

Use this method to subscribe to another entity's presence.

Syntax

fn subscribe_to(&self, jabber_id : &str) -> Result<(), IPWorksError>

Remarks

This method will send a request for a subscription to jabber_id's presence. If the entity allows the subscription, a new item will be stored in the buddy list with the appropriate subscription type. Otherwise, no change will take place.

unregister method (XMPP Struct)

This method cancels an account with the host.

Syntax

fn unregister(&self) -> Result<(), IPWorksError>

Remarks

If the user or application wishes to terminate an account with the im_server it should make a call to this method. After a successful call, the account will be canceled and the struct will be logged off the server, but not disconnected.

unsubscribe_to method (XMPP Struct)

This method will cancel a subscription to another entity's presence.

Syntax

fn unsubscribe_to(&self, jabber_id : &str) -> Result<(), IPWorksError>

Remarks

This method will inform the server of the cancellation of a subscription to jabber_id's presence. After a successful call, the subscription type of the associated buddy list item will be updated.

update_buddy_group method (XMPP Struct)

This method updates the buddy's associated groups.

Syntax

fn update_buddy_group(&self, buddy_index : i32, group : &str) -> Result<(), IPWorksError>

Remarks

This method updates the associated groups for the buddy specified by buddy_index.

After the on_sync event has fired, the buddy_group property is populated with a comma-separated list of groups for each buddy. To update the groups for a buddy, call this method with the buddy's index and the comma-separated list of groups the buddy should be associated with. Setting group to an empty string ("") will cause the buddy to be completely disassociated from all groups.

on_buddy_update event (XMPP Struct)

This event is fired whenever a roster entry is updated.

Syntax

// XMPPBuddyUpdateEventArgs carries the XMPP BuddyUpdate event's parameters.
pub struct XMPPBuddyUpdateEventArgs {
  fn buddy_idx(&self) -> i32
}

// XMPPBuddyUpdateEvent defines the signature of the XMPP BuddyUpdate event's handler function.
pub trait XMPPBuddyUpdateEvent {
  fn on_buddy_update(&self, sender : XMPP, e : &mut XMPPBuddyUpdateEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_buddy_update(&self) -> &'a dyn XMPPBuddyUpdateEvent;
  pub fn set_on_buddy_update(&mut self, value : &'a dyn XMPPBuddyUpdateEvent);
  ...
}

Remarks

The on_buddy_update event will fire whenever a new buddy list entry is added or an old entry is updated. The updated information can be retrieved through the buddies properties property. The buddy_idx parameter of this event will be the index of that XMPPBuddy in the properties.

on_connected event (XMPP Struct)

This event is fired when a connection to the IM server is completed.

Syntax

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

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

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

Remarks

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 Transmission Control Protocol (TCP)/IP stack. description contains a description of this code. The value of status_code is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_connection_status event (XMPP Struct)

Fired to indicate changes in the connection state.

Syntax

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

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

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

Remarks

This event is fired when the connection state changes: for example, 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_disconnected event (XMPP Struct)

This event is fired when the chat service connection is lost.

Syntax

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

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

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

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_end_transfer event (XMPP Struct)

This event is fired when a file transfer completes.

Syntax

// XMPPEndTransferEventArgs carries the XMPP EndTransfer event's parameters.
pub struct XMPPEndTransferEventArgs {
  fn direction(&self) -> i32
  fn file_id(&self) -> &String
  fn file_name(&self) -> &String
  fn success(&self) -> bool
}

// XMPPEndTransferEvent defines the signature of the XMPP EndTransfer event's handler function.
pub trait XMPPEndTransferEvent {
  fn on_end_transfer(&self, sender : XMPP, e : &mut XMPPEndTransferEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn XMPPEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn XMPPEndTransferEvent);
  ...
}

Remarks

When a file transfer completes, this event will fire.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error event (XMPP Struct)

This event is fired when the server sends a protocol error message.

Syntax

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

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

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

Remarks

This event is fired whenever there is a protocol error. error_code will contain the error code string sent by the server. description will contain the Xmpp struct's interpretation of the code.

on_iq event (XMPP Struct)

This event is fired for IQ messages not normally supported by the struct.

Syntax

// XMPPIQEventArgs carries the XMPP IQ event's parameters.
pub struct XMPPIQEventArgs {
  fn iq(&self) -> &String
  fn id(&self) -> &String
  fn from(&self) -> &String
  fn iq_type(&self) -> &String
  fn ignore(&self) -> bool
  fn set_ignore(&self, value : bool)
}

// XMPPIQEvent defines the signature of the XMPP IQ event's handler function.
pub trait XMPPIQEvent {
  fn on_iq(&self, sender : XMPP, e : &mut XMPPIQEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_iq(&self) -> &'a dyn XMPPIQEvent;
  pub fn set_on_iq(&mut self, value : &'a dyn XMPPIQEvent);
  ...
}

Remarks

Some servers may wish to gather some data from the client in ways not specified by the XMPP RFC. This event will contain any IQ message that is not a part of the Jabber specification. The iq parameter will contain an entire XML entity, and thus it will require both knowledge of XML and knowledge of the possible contents of the IQ message to parse. id will contain the transaction Id of the IQ message. from will contain the sender's Jabber Id. iq_type will have one of the following values:

NOTE: To respond to these IQs, you may use the send_command method.

on_message_in event (XMPP Struct)

This event is fired upon receipt of a message.

Syntax

// XMPPMessageInEventArgs carries the XMPP MessageIn event's parameters.
pub struct XMPPMessageInEventArgs {
  fn message_id(&self) -> &String
  fn from(&self) -> &String
  fn domain(&self) -> &String
  fn resource(&self) -> &String
  fn message_type(&self) -> i32
  fn subject(&self) -> &String
  fn message_thread(&self) -> &String
  fn message_text(&self) -> &String
  fn message_html(&self) -> &String
  fn other(&self) -> &String
}

// XMPPMessageInEvent defines the signature of the XMPP MessageIn event's handler function.
pub trait XMPPMessageInEvent {
  fn on_message_in(&self, sender : XMPP, e : &mut XMPPMessageInEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_message_in(&self) -> &'a dyn XMPPMessageInEvent;
  pub fn set_on_message_in(&mut self, value : &'a dyn XMPPMessageInEvent);
  ...
}

Remarks

When a message is received, the XMPP struct will parse the sender's Jabber Id into the from, domain, and resource fields. These parameters can be used to track the exact instance of a user's account that originated the message.

message_id can be used with Jabber extension protocols. The message_text parameter is the plaintext portion of the message body. message_html will contain any HTML from the message.

Type is the type of message received. See message_type for a list of possible values. For a message of type "headline", subject will reflect the subject of the message. For a message of type "chat", Thread will report the conversation thread for which the current message is a follow-up.

other will contain any extra data associated with the message but not defined by the XMPP-IM protocol.

on_pi_trail event (XMPP Struct)

This event is fired for all protocol messages.

Syntax

// XMPPPITrailEventArgs carries the XMPP PITrail event's parameters.
pub struct XMPPPITrailEventArgs {
  fn direction(&self) -> i32
  fn pi(&self) -> &String
}

// XMPPPITrailEvent defines the signature of the XMPP PITrail event's handler function.
pub trait XMPPPITrailEvent {
  fn on_pi_trail(&self, sender : XMPP, e : &mut XMPPPITrailEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_pi_trail(&self) -> &'a dyn XMPPPITrailEvent;
  pub fn set_on_pi_trail(&mut self, value : &'a dyn XMPPPITrailEvent);
  ...
}

Remarks

The on_pi_trail event is useful for debugging purposes. It shows all the interactions between the client and the server, line by line.

SessionId will hold the session number that originated the PI. A value of 0 is reserved for all PI dealing with the im_server.

The direction parameter shows the originator of the message:

The pi parameter contains the PI message.

on_presence event (XMPP Struct)

This event is fired when the presence of a subscribed entity changes.

Syntax

// XMPPPresenceEventArgs carries the XMPP Presence event's parameters.
pub struct XMPPPresenceEventArgs {
  fn user(&self) -> &String
  fn domain(&self) -> &String
  fn resource(&self) -> &String
  fn availability(&self) -> i32
  fn status(&self) -> &String
}

// XMPPPresenceEvent defines the signature of the XMPP Presence event's handler function.
pub trait XMPPPresenceEvent {
  fn on_presence(&self, sender : XMPP, e : &mut XMPPPresenceEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_presence(&self) -> &'a dyn XMPPPresenceEvent;
  pub fn set_on_presence(&mut self, value : &'a dyn XMPPPresenceEvent);
  ...
}

Remarks

This event contains the availability and status information of a particular Jabber entity to whom this entity has a subscription.

Because a user can log in multiple times using the same account, the XMPP struct will parse the user's Jabber Id into the user, domain, and resource parameters so that the client can easily track which instance of the account sent the presence.

The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The register method can be used to register with a foreign network gateway.

availability corresponds to the presence property of the struct, with the same possible values:

By default, the struct sets the client presence to pcChat, meaning that the user is available.

NOTE: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an on_error.

status corresponds to the status property. This value may be any random string, including the empty string, "".

on_ready_to_send event (XMPP Struct)

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

Syntax

// XMPPReadyToSendEventArgs carries the XMPP ReadyToSend event's parameters.
pub struct XMPPReadyToSendEventArgs {
}

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

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

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_ssl_server_authentication event (XMPP Struct)

Fired after the server presents its certificate to the client.

Syntax

// XMPPSSLServerAuthenticationEventArgs carries the XMPP SSLServerAuthentication event's parameters.
pub struct XMPPSSLServerAuthenticationEventArgs {
  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)
}

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

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

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

Fired when secure connection progress messages are available.

Syntax

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

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

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

Remarks

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

on_start_transfer event (XMPP Struct)

This event is fired when a file transfer begins.

Syntax

// XMPPStartTransferEventArgs carries the XMPP StartTransfer event's parameters.
pub struct XMPPStartTransferEventArgs {
  fn direction(&self) -> i32
  fn file_id(&self) -> &String
  fn user(&self) -> &String
  fn domain(&self) -> &String
  fn resource(&self) -> &String
  fn file_name(&self) -> &String
  fn set_file_name(&self, value : &str)
  fn set_file_name_ref(&self, value : &String)
  fn datetime(&self) -> &String
  fn size(&self) -> i64
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// XMPPStartTransferEvent defines the signature of the XMPP StartTransfer event's handler function.
pub trait XMPPStartTransferEvent {
  fn on_start_transfer(&self, sender : XMPP, e : &mut XMPPStartTransferEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn XMPPStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn XMPPStartTransferEvent);
  ...
}

Remarks

When a file is received, the XMPP component will parse the sender's Jabber Id into the User, Domain, and Resource fields. The file_id and file_name parameters identify the current transfer. Within this event, you may override the file_name by setting the file_name parameter. At this time, you may also set local_directory if it is not already set.

When sending a file, the XMPP component will parse the receiver's Jabber Id into the User, Domain, and Resource fields.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_subscription_request event (XMPP Struct)

This event fires when a subscription request is received.

Syntax

// XMPPSubscriptionRequestEventArgs carries the XMPP SubscriptionRequest event's parameters.
pub struct XMPPSubscriptionRequestEventArgs {
  fn from(&self) -> &String
  fn domain(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// XMPPSubscriptionRequestEvent defines the signature of the XMPP SubscriptionRequest event's handler function.
pub trait XMPPSubscriptionRequestEvent {
  fn on_subscription_request(&self, sender : XMPP, e : &mut XMPPSubscriptionRequestEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_subscription_request(&self) -> &'a dyn XMPPSubscriptionRequestEvent;
  pub fn set_on_subscription_request(&mut self, value : &'a dyn XMPPSubscriptionRequestEvent);
  ...
}

Remarks

This event fires whenever another XMPP entity requests a subscription to this entity's presence. The XMPP struct will parse the requesting entity's Jabber Id into the from and domain parameters. It is not necessary to know which resource sent the request, because all instances of the requesting entity's account have access to the same roster.

accept will initially be False, but setting it to True will cause the XMPP struct to allow the remote subscription. Otherwise, the XMPP struct will actively deny the subscription request.

on_sync event (XMPP Struct)

This event fires upon a complete information synchronization with the server.

Syntax

// XMPPSyncEventArgs carries the XMPP Sync event's parameters.
pub struct XMPPSyncEventArgs {
}

// XMPPSyncEvent defines the signature of the XMPP Sync event's handler function.
pub trait XMPPSyncEvent {
  fn on_sync(&self, sender : XMPP, e : &mut XMPPSyncEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_sync(&self) -> &'a dyn XMPPSyncEvent;
  pub fn set_on_sync(&mut self, value : &'a dyn XMPPSyncEvent);
  ...
}

Remarks

The on_sync event will fire after each successful call to the retrieve_roster method. When the event fires, the buddy list, or roster, will be completely retrieved and the buddies properties will be filled out accordingly:

NOTE: Please refer to buddies properties property for more information.

on_transfer event (XMPP Struct)

This event is fired during file transfer.

Syntax

// XMPPTransferEventArgs carries the XMPP Transfer event's parameters.
pub struct XMPPTransferEventArgs {
  fn direction(&self) -> i32
  fn file_id(&self) -> &String
  fn file_name(&self) -> &String
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// XMPPTransferEvent defines the signature of the XMPP Transfer event's handler function.
pub trait XMPPTransferEvent {
  fn on_transfer(&self, sender : XMPP, e : &mut XMPPTransferEventArgs);
}

impl <'a> XMPP<'a> {
  pub fn on_transfer(&self) -> &'a dyn XMPPTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn XMPPTransferEvent);
  ...
}

Remarks

This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.

The bytes_transferred parameter shows the number of bytes transferred since the beginning of the transfer.

text contains the portion of the file data being delivered.

The direction parameter shows whether the client (0) or the server (1) is sending the data.

The percent_done parameter shows the progress of the transfer in the corresponding direction. If percent_done cannot be calculated, the value will be -1.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (XMPP Struct)

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

XMPP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors