Struct ipworksmq::AmazonSQS

Properties   Methods   Events   Config Settings   Errors  

The AmazonSQS Struct provides an easy interface to Amazon's Simple Queue Service (SQS).

Syntax

ipworksmq::AmazonSQS

Remarks

The AmazonSQS Struct allows you to access Amazon's Simple Queue Service (SQS). SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. A brief synopsis follows but please refer to Amazon SQS documentation for details.

You will first need to sign up for the SQS service and obtain the access_key and secret_key from Amazon. Then you can start creating queues in your account using create_queue. You can then start adding message's to the queue using create_message and retrieve the same using list_messages.

There are other methods such as list_queues, delete_queue, delete_message etc. that further enable you to manage your SQS queues.

SmoothMQ is also supported. For compatibility with SmoothMQ, APIRequestFormat must be set to 2. Additionally, it is advisable to set ResolveQueueId to true.

Object Lifetime

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

access_key property (AmazonSQS Struct)

The Access Key Id for the Amazon Web Services account.

Syntax

fn access_key(&self ) -> Result<String, IPWorksMQError> 
fn set_access_key(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_access_key_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the secret_key to authenticate with Amazon servers.

Data Type

String

attributes_count property (AmazonSQS Struct)

The number of records in the Attributes arrays.

Syntax

fn attributes_count(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attributes_name
• attributes_value

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

This property is read-only.

Data Type

i32

attributes_name property (AmazonSQS Struct)

The name of the attribute.

Syntax

fn attributes_name(&self , AttributesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of the attribute.

The AttributesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributesCount property.

This property is read-only.

Data Type

String

attributes_value property (AmazonSQS Struct)

The value of the attribute.

Syntax

fn attributes_value(&self , AttributesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The value of the attribute.

The AttributesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributesCount property.

This property is read-only.

Data Type

String

firewall_auto_detect property (AmazonSQS Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

firewall_type property (AmazonSQS Struct)

The type of firewall to connect through.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

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

max_messages property (AmazonSQS Struct)

The maximum number of messages retrieved from the queue.

Syntax

fn max_messages(&self ) -> Result<i32, IPWorksMQError> 
fn set_max_messages(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

1

Remarks

The maximum number of messages retrieved by list_messages. This is not the number of messages that will be returned, but just the maximum number that will be returned.

Amazon's SQS service dictates that this parameter should be between 1 to 10, all other values are illegal.

Data Type

i32

messages_count property (AmazonSQS Struct)

The number of records in the Messages arrays.

Syntax

fn messages_count(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• messages_body
• messages_id
• messages_md5
• messages_receipt_handle

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

This property is read-only.

Data Type

i32

messages_body property (AmazonSQS Struct)

The body of the SQS message.

Syntax

fn messages_body(&self , MessagesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The body of the SQS message.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is read-only.

Data Type

String

messages_id property (AmazonSQS Struct)

The ID of the SQS message.

Syntax

fn messages_id(&self , MessagesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The ID of the SQS message.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is read-only.

Data Type

String

messages_md5 property (AmazonSQS Struct)

The MD5 of the SQS message.

Syntax

fn messages_md5(&self , MessagesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The MD5 of the SQS message.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is read-only.

Data Type

String

messages_receipt_handle property (AmazonSQS Struct)

The Receipt handle of the SQS message.

Syntax

fn messages_receipt_handle(&self , MessagesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The Receipt handle of the SQS message.

The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.

This property is read-only.

Data Type

String

other_headers property (AmazonSQS Struct)

Other headers as determined by the user (optional).

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

proxy_auth_scheme property (AmazonSQS Struct)

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

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

i32

proxy_auto_detect property (AmazonSQS Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

proxy_password property (AmazonSQS Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

proxy_port property (AmazonSQS Struct)

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

Syntax

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

Default Value

80

Remarks

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

Data Type

i32

proxy_server property (AmazonSQS Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

proxy_ssl property (AmazonSQS Struct)

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

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

Data Type

i32

proxy_user property (AmazonSQS Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

queue_prefix property (AmazonSQS Struct)

QueuePrefix can be used to filter the queues listed.

Syntax

fn queue_prefix(&self ) -> Result<String, IPWorksMQError> 
fn set_queue_prefix(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_queue_prefix_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

Only the queues whose names start with the specified queue_prefix are listed when list_queues is called.

Data Type

String

queues_count property (AmazonSQS Struct)

The number of records in the Queues arrays.

Syntax

fn queues_count(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• queues_id
• queues_url

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

This property is read-only.

Data Type

i32

queues_id property (AmazonSQS Struct)

The ID of the SQS queue.

Syntax

fn queues_id(&self , QueuesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The ID of the SQS queue.

The QueuesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueuesCount property.

This property is read-only.

Data Type

String

queues_url property (AmazonSQS Struct)

The URL of the SQS queue.

Syntax

fn queues_url(&self , QueuesIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The URL of the SQS queue.

The QueuesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueuesCount property.

This property is read-only.

Data Type

String

referer property (AmazonSQS Struct)

This property includes the referer URL/document (optional).

Syntax

fn referer(&self ) -> Result<String, IPWorksMQError> 
fn set_referer(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_referer_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

Data Type

String

secret_key property (AmazonSQS Struct)

The Secret Access Key for the Amazon Web Services account.

Syntax

fn secret_key(&self ) -> Result<String, IPWorksMQError> 
fn set_secret_key(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_secret_key_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This property describes the secret key to the Amazon account. It should not be shared with others. The secret_key is used along with the access_key in the authentication process with Amazon servers.

Data Type

String

ssl_accept_server_cert_effective_date property (AmazonSQS Struct)

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

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

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

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

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

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

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

Data Type

Vec

ssl_provider property (AmazonSQS Struct)

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

Syntax

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

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

The date on which this certificate becomes valid.

Syntax

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

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

The date on which the certificate expires.

Syntax

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

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

A comma-delimited list of extended key usage identifiers.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The issuer of the certificate.

Syntax

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

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

The private key of the certificate (if available).

Syntax

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

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

Whether a PrivateKey is available for the selected certificate.

Syntax

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

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

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

Syntax

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

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

The public key of the certificate.

Syntax

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

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

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

Syntax

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

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

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

Syntax

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

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

The serial number of the certificate encoded as a string.

Syntax

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

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

The text description of the certificate's signature algorithm.

Syntax

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

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

The name of the certificate store for the client certificate.

Syntax

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

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 (AmazonSQS 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, IPWorksMQError> 

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

The type of certificate store for this certificate.

Syntax

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

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

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

Syntax

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

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

The MD5 hash of the certificate.

Syntax

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

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

The SHA-1 hash of the certificate.

Syntax

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

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

The SHA-256 hash of the certificate.

Syntax

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

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

The text description of UsageFlags .

Syntax

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

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

The flags that show intended use for the certificate.

Syntax

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

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

The certificate's version number.

Syntax

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

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

The subject of the certificate used for client authentication.

Syntax

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

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

The certificate (PEM/Base64 encoded).

Syntax

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

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

status_line property (AmazonSQS Struct)

This property is the first line of the last server response.

Syntax

fn status_line(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the struct, the error string is the same as the status_line property.

The HTTP protocol specifies the structure of the status_line as follows: [HTTP version] [Result Code] [Description].

This property is read-only.

Data Type

String

timeout property (AmazonSQS Struct)

The timeout for the struct.

Syntax

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

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

use_ssl property (AmazonSQS Struct)

Use SSL when accessing the service.

Syntax

fn use_ssl(&self ) -> Result<bool, IPWorksMQError> 
fn set_use_ssl(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

true

Remarks

Use this property to specify whether the struct should use SSL when connecting to the service.

Data Type

bool

visibility_timeout property (AmazonSQS Struct)

The visibility duration for messages in the queue.

Syntax

fn visibility_timeout(&self ) -> Result<i32, IPWorksMQError> 
fn set_visibility_timeout(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

-1

Remarks

Visibility timeout is used to guard against multiple delivery. Successive calls to list_messages on a queue will not return any message again until the timeout expires, after which the message may reappear unless deleted with delete_message.

A default visibility timeout is configured when a queue is created using create_queue, it can also be altered when a message is added using create_message or when they are retrieved using list_messages.

The default value for visibility_timeout is -1, which notifies the component that you would like to use the default behavior for the current Queue.

NOTE: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their visibility_timeout. Attempting to call delete_message for a message received from a FIFO queue after its visibility_timeout has expired will cause the server to return an error. Keep this in mind when picking a visibility_timeout value to create a FIFO queue and/or retrieve messages with.

Data Type

i32

add_permission method (AmazonSQS Struct)

Adds a permission to a queue for a specific account, which allows for sharing access to the queue.

Syntax

fn add_permission(&self, queue_id : &str, user_label : &str, amazon_account : &str, permission_name : &str) ->  Result<String, IPWorksMQError>

Remarks

This method adds a permission to the queue specified by QueueId for the user account specified by AmazonAccount. UserLabel is the unique identification of the permission you're granting, and is used when deleting the permission via the remove_permission method. The current list of values you may pass in the PermissionName parameter are listed below:

• SendMessage
• ReceiveMessage
• DeleteMessage
• ChangeMessageVisibility
• GetQueueAttributes

Note that when you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue.

add_permission writes an SQS-generated policy. If you want to write your own policy, use set_queue_attribute to upload your policy.

This method returns the RequestId contained in the Amazon response.

change_message_visibility method (AmazonSQS Struct)

Changes the visibility timeout of a message.

Syntax

fn change_message_visibility(&self, queue_id : &str, receipt_handle : &str, visiblity_timeout : i32) ->  Result<String, IPWorksMQError>

Remarks

Changes the visibility of the message specified by ReceiptHandle in the queue specified by QueueId. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.

This method returns the RequestId contained in the Amazon response.

config method (AmazonSQS Struct)

Sets or retrieves a configuration setting.

Syntax

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

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.

create_message method (AmazonSQS Struct)

Adds a message to a queue.

Syntax

fn create_message(&self, queue_id : &str, message : &str) ->  Result<String, IPWorksMQError>

Remarks

Adds a message to the queue specified. If visibility_timeout is specified it is updated for all the messages in the queue.

create_message returns a message id assigned to the message that is added to a queue. This can then be used to list_messages or delete_message.

Note: When adding a message to a FIFO queue, the MessageGroupId configuration setting must be populated before calling this method.

create_queue method (AmazonSQS Struct)

Creates an SQS queue.

Syntax

fn create_queue(&self, queue_name : &str) ->  Result<String, IPWorksMQError>

Remarks

A queue with the specified name is created.

create_queue returns a queue id assigned to the queue. This can then be used to create_message or delete_queue.

If the QueueName ends with .fifo, the queue will be created as a FIFO queue. Alternatively, if the UseFIFOQueues configuration setting is enabled, the struct will always attempt to create FIFO queues, appending .fifo to the given QueueName if necessary (all FIFO queues' names must have that suffix).

delete_message method (AmazonSQS Struct)

Deletes the message specified.

Syntax

fn delete_message(&self, queue_id : &str, receipt_handle : &str) -> Result<(), IPWorksMQError>

Remarks

Deletes the message specified by ReceiptHandle from the queue specified by QueueId.

NOTE: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their visibility_timeout. Attempting to call delete_message for a message received from a FIFO queue after its visibility_timeout has expired will cause the server to return an error.

delete_queue method (AmazonSQS Struct)

Deletes a queue.

Syntax

fn delete_queue(&self, queue_id : &str) -> Result<(), IPWorksMQError>

Remarks

Deletes the queue specified by QueueId.

do_events method (AmazonSQS Struct)

This method processes events from the internal message queue.

Syntax

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

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.

get_queue_attributes method (AmazonSQS Struct)

Returns all attributes of a queue.

Syntax

fn get_queue_attributes(&self, queue_id : &str) ->  Result<String, IPWorksMQError>

Remarks

This method retrieves all of the attributes of the queue specified by QueueId, and stores them in the attributes collection. Queues currently have five attributes that may be returned:

• ApproximateNumberOfMessages
• VisibilityTimeout (for more information, see Visibility Timeout)
• CreatedTimestamp
• LastModifiedTimestamp
• Policy

This method returns the RequestId contained in the Amazon response.

get_xvalue method (AmazonSQS Struct)

Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .

Syntax

fn get_xvalue(&self, xpath : &str) ->  Result<String, IPWorksMQError>

Remarks

This method allows a user to retrieve a valid XPath expression from the HTTP response after calling send_custom_request.

interrupt method (AmazonSQS Struct)

This method interrupts the current method.

Syntax

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

Remarks

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

list_messages method (AmazonSQS Struct)

Gets messages from the queue.

Syntax

fn list_messages(&self, queue_id : &str) -> Result<(), IPWorksMQError>

Remarks

This method retrieves messages from the queue specified by QueueId, and fires a on_message event for each message it receives. The messages may also be accessed using the property messages.

If visibility_timeout greater than -1 it is applied to the messages, otherwise the default timeout of the queue used. Only one message is retrieved by default; this behavior may be modified by changing max_messages.

NOTE: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their visibility_timeout. Attempting to call delete_message for a message received from a FIFO queue after its visibility_timeout has expired will cause the server to return an error.

list_queues method (AmazonSQS Struct)

Lists the queues under the current account.

Syntax

fn list_queues(&self) -> Result<(), IPWorksMQError>

Remarks

This method will fire a on_queue event for each queue available for the Amazon SQS account specified by access_key. The listing may be filtered using queue_prefix.

remove_permission method (AmazonSQS Struct)

The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter.

Syntax

fn remove_permission(&self, queue_id : &str, user_label : &str) ->  Result<String, IPWorksMQError>

Remarks

Note that only the owner of the queue may revoke previously added permissions.

This method returns the RequestId contained in the Amazon response.

reset method (AmazonSQS Struct)

Resets request-related properties.

Syntax

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

Remarks

Calling this method will reset the component to the original state.

reset_headers method (AmazonSQS Struct)

Resets all HTTP headers, cookies, and LocalFile.

Syntax

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

Remarks

Resets all the HTTP headers as well as local_file to "" (empty string).

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

send_custom_request method (AmazonSQS Struct)

Allows the sending of a custom request to an Amazon web service.

Syntax

fn send_custom_request(&self, url : &str, request_data : &str, other_headers : &str) ->  Result<String, IPWorksMQError>

Remarks

Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.

set_queue_attribute method (AmazonSQS Struct)

Sets an attribute of a queue.

Syntax

fn set_queue_attribute(&self, queue_id : &str, attribute_name : &str, attribute_value : &str) ->  Result<String, IPWorksMQError>

Remarks

This method sets attributes of the queue specified by QueueId. When you change a queue's attributes, the change can take up to 60 seconds to propagate throughout the SQS system.

This method returns the RequestId contained in the Amazon response.

on_connected event (AmazonSQS Struct)

Fired immediately after a connection completes (or fails).

Syntax

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

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

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

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_disconnected event (AmazonSQS Struct)

Fired when a connection is closed.

Syntax

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

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

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

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

Fired when a document finishes transferring.

Syntax

// AmazonSQSEndTransferEventArgs carries the AmazonSQS EndTransfer event's parameters.
pub struct AmazonSQSEndTransferEventArgs {
  fn direction(&self) -> i32
}

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

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

Remarks

This event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

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

on_error event (AmazonSQS Struct)

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

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

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

on_header event (AmazonSQS Struct)

Fired every time a header line comes in.

Syntax

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

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

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

Remarks

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

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

on_message event (AmazonSQS Struct)

Fired for each message retrieved from the queue.

Syntax

// AmazonSQSMessageEventArgs carries the AmazonSQS Message event's parameters.
pub struct AmazonSQSMessageEventArgs {
  fn message_id(&self) -> &String
  fn receipt_handle(&self) -> &String
  fn message_data(&self) -> &String
  fn md5(&self) -> &String
}

// AmazonSQSMessageEvent defines the signature of the AmazonSQS Message event's handler function.
pub trait AmazonSQSMessageEvent {
  fn on_message(&self, sender : AmazonSQS, e : &mut AmazonSQSMessageEventArgs);
}

impl <'a> AmazonSQS<'a> {
  pub fn on_message(&self) -> &'a dyn AmazonSQSMessageEvent;
  pub fn set_on_message(&mut self, value : &'a dyn AmazonSQSMessageEvent);
  ...
}

Remarks

When list_messages is invoked the struct fires on_message for each message retrieved. The number of messages retrieved are specified using max_messages. OtherData is reserved for future use.

on_queue event (AmazonSQS Struct)

Fired for each queue of the user.

Syntax

// AmazonSQSQueueEventArgs carries the AmazonSQS Queue event's parameters.
pub struct AmazonSQSQueueEventArgs {
  fn queue_id(&self) -> &String
  fn url(&self) -> &String
}

// AmazonSQSQueueEvent defines the signature of the AmazonSQS Queue event's handler function.
pub trait AmazonSQSQueueEvent {
  fn on_queue(&self, sender : AmazonSQS, e : &mut AmazonSQSQueueEventArgs);
}

impl <'a> AmazonSQS<'a> {
  pub fn on_queue(&self) -> &'a dyn AmazonSQSQueueEvent;
  pub fn set_on_queue(&mut self, value : &'a dyn AmazonSQSQueueEvent);
  ...
}

Remarks

When list_queues is invoked the struct fires on_queue for each queue.

on_ssl_server_authentication event (AmazonSQS Struct)

Fired after the server presents its certificate to the client.

Syntax

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

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

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

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

Fired when secure connection progress messages are available.

Syntax

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

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

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

Remarks

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

on_start_transfer event (AmazonSQS Struct)

Fired when a document starts transferring (after the headers).

Syntax

// AmazonSQSStartTransferEventArgs carries the AmazonSQS StartTransfer event's parameters.
pub struct AmazonSQSStartTransferEventArgs {
  fn direction(&self) -> i32
}

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

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

Remarks

This event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

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

on_status event (AmazonSQS Struct)

Fired when the HTTP status line is received from the server.

Syntax

// AmazonSQSStatusEventArgs carries the AmazonSQS Status event's parameters.
pub struct AmazonSQSStatusEventArgs {
  fn http_version(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// AmazonSQSStatusEvent defines the signature of the AmazonSQS Status event's handler function.
pub trait AmazonSQSStatusEvent {
  fn on_status(&self, sender : AmazonSQS, e : &mut AmazonSQSStatusEventArgs);
}

impl <'a> AmazonSQS<'a> {
  pub fn on_status(&self) -> &'a dyn AmazonSQSStatusEvent;
  pub fn set_on_status(&mut self, value : &'a dyn AmazonSQSStatusEvent);
  ...
}

Remarks

http_version is a string containing the HTTP version string as returned from the server (e.g., "1.1").

status_code contains the HTTP status code (e.g., 200), and description the associated message returned by the server (e.g., "OK").

on_transfer event (AmazonSQS Struct)

Fired while a document transfers (delivers document).

Syntax

// AmazonSQSTransferEventArgs carries the AmazonSQS Transfer event's parameters.
pub struct AmazonSQSTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

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

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

Remarks

The text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The bytes_transferred parameter contains the number of bytes transferred in this direction since the beginning of the document text (excluding HTTP response headers).

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

AmazonSQS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Trappable Errors (AmazonSQS Struct)

AmazonSQS Errors

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

HTTP 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