# Struct ipworksiot::AMQPClassic An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions. ## Syntax ```text ipworksiot::AMQPClassic ``` ## Remarks The AMQPClassic struct provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The struct supports both plaintext and TLS-enabled connections over TCP. ### Connecting The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection. The struct implements both layers, so the first step is to initiate the overall connection. Set the [auth_scheme](#auth_scheme-property-amqpclassic-struct), [user](#user-property-amqpclassic-struct), [password](#password-property-amqpclassic-struct), [ssl_enabled](#ssl_enabled-property-amqpclassic-struct), and [virtual_host](#virtual_host-property-amqpclassic-struct) properties if necessary, then call the [connect_to](#connect_to-method-amqpclassic-struct) method, passing it the server's hostname and port number. (If the server in question is not running RabbitMQ, disabling the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting before connecting is also recommended.) The next step is to create at least one channel, which can be accomplished by using the [create_channel](#create_channel-method-amqpclassic-struct) method. The struct allows creating any number of channels, up to the limit specified by the [MaxChannelCount](#MaxChannelCount) configuration setting. **Connecting and Creating a Channel** ```csharp // The examples in this documentation use a RabbitMQ server, which requires SASL Plain auth. amqpc1.AuthScheme = AmqpclassicAuthSchemes.smSASLPlain; amqpc1.User = "guest"; amqpc1.Password = "guest"; amqpc1.SSLEnabled = true; amqpc1.ConnectTo("amqpclassic.test-server.com", 5671); amqpc1.CreateChannel("channel"); ``` Once the struct has connected to the server, and one or more channels have been opened, the struct can begin manipulating exchanges and queues, publishing messages, and creating consumers. Note that most AMQP 0.9.1 operations can themselves vary in their complexity. The examples below are intentionally simple for the sake of clarity and brevity, but links are provided for many other parts of the struct's API where more detail can be found. ### Declaring Exchanges The [declare_exchange](#declare_exchange-method-amqpclassic-struct) method is used to declare (i.e., create, or verify the existence of) exchanges on the server. While all AMQP servers provide a default, *direct*-type exchange that all queues are bound to automatically (using their name as the routing key), more complex use-cases will often require creating additional exchanges of varying types. **Declaring an Exchange** ```csharp // Declare a direct-type exchange. amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false); ``` Exchanges can also be deleted using the [delete_exchange](#delete_exchange-method-amqpclassic-struct) method. ### Declaring Queues The [declare_queue](#declare_queue-method-amqpclassic-struct) method is used to declare (i.e., create, or verify the existence of) queues on the server. Unlike with exchanges, the server does not provide any queues by default, so declaring a queue is always necessary (unless one has already been created by another client, or configured ahead-of-time on the server itself). **Declaring a Queue** ```csharp // Declare a queue. amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false); ``` Queues may also be deleted or purged using the [delete_queue](#delete_queue-method-amqpclassic-struct) and [purge_queue](#purge_queue-method-amqpclassic-struct) methods. ### Binding Queues to Exchanges The [bind_queue](#bind_queue-method-amqpclassic-struct) method is used to bind a queue to an exchange. Exchanges use the information held by their queue bindings to determine which messages to forward to which queues. Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a *direct* exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call [publish_message](#publish_message-method-amqpclassic-struct), pass empty string for *ExchangeName*, and the name of the desired queue for *RoutingKey*. **Binding a Queue to an Exchange** ```csharp // Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey". amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false); ``` Queues can also be unbound from exchanges using the [unbind_queue](#unbind_queue-method-amqpclassic-struct) method. ### Publishing Messages To publish a message, populate the message property's properties, and then call the [publish_message](#publish_message-method-amqpclassic-struct) method. **Publishing a Message** ```csharp amqpc1.Message.Body = "Hello, world!"; // Publish a message to the server's default (no-name) exchange, using the name of a specific queue as the routing key. amqpc1.PublishMessage("channel", "", "MyQueue", false, false); // Publish a message to the "MyExchange" exchange, using the routing key "MyRoutingKey". amqpc1.PublishMessage("channel", "MyExchange", "MyRoutingKey", false, false); ``` Note that outgoing messages may be handled differently by the server if the channel they are sent over is in transaction or (for RabbitMQ only) "publish confirmations" mode. Refer to the [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) and [enable_publish_confirms](#enable_publish_confirms-method-amqpclassic-struct) methods for more information. ### Receiving Messages There are two possible ways for the struct to receive a message: - Messages can be asynchronously *pushed* to the struct from the server. At any point in time, the server may push a message to the struct from a queue that the [consume](#consume-method-amqpclassic-struct) method has been used to attach a consumer to. - Messages can be synchronously *pulled* from the server by the struct. The [retrieve_message](#retrieve_message-method-amqpclassic-struct) method is used to attempt to pull (or "retrieve") messages from a specific queue. Regardless of how they are received, all incoming messages cause the received_message property's properties to be populated and the [on_message_in](#on_message_in-event-amqpclassic-struct) event to fire. **Receiving a Message** ```csharp // MessageIn event handler. amqpc1.OnMessageIn += (s, e) => { if (e.MessageCount == -1) { // The server pushed a message to us asynchronously due to a consumer we created. Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':"); Console.WriteLine(amqpc1.ReceivedMessage.Body); } else if (e.DeliveryTag > 0) { // We pulled a message from a queue with the RetrieveMessage() method. Console.WriteLine("Message successfully pulled:"); Console.WriteLine(amqpc1.ReceivedMessage.Body); Console.WriteLine(e.MessageCount + " messages are still available to pull."); } else { // We tried to pull a message, but there were none available to pull. Console.WriteLine("No messages available to pull."); } }; // Attach a consumer to "MyQueue". amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false); // Or, try to retrieve a message from "MyQueue". amqpc1.RetrieveMessage("channel", "MyQueue", true); ``` Note that the [on_message_in](#on_message_in-event-amqpclassic-struct) event *always* fires if [retrieve_message](#retrieve_message-method-amqpclassic-struct) is called successfully, even if there were no messages available to retrieve; refer to [on_message_in](#on_message_in-event-amqpclassic-struct) for more information. ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksIoT. Due to this, the AMQPClassic struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of AMQPClassic 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.* | | | | --- | --- | | [argument_count](#argument_count-property-amqpclassic-struct) | The number of records in the Argument arrays. | | [argument_name](#argument_name-property-amqpclassic-struct) | The table property's name. | | [argument_value](#argument_value-property-amqpclassic-struct) | The table property's value. | | [argument_value_type](#argument_value_type-property-amqpclassic-struct) | The table property's value type. | | [auth_scheme](#auth_scheme-property-amqpclassic-struct) | The authentication scheme to use when connecting. | | [channel_count](#channel_count-property-amqpclassic-struct) | The number of records in the Channel arrays. | | [channel_accept](#channel_accept-property-amqpclassic-struct) | Whether the channel is currently accepting new messages from the server. | | [channel_mode](#channel_mode-property-amqpclassic-struct) | What mode the channel is operating in. | | [channel_name](#channel_name-property-amqpclassic-struct) | The name of the channel. | | [channel_ready_to_send](#channel_ready_to_send-property-amqpclassic-struct) | Whether the channel is ready to send a message. | | [client_property_count](#client_property_count-property-amqpclassic-struct) | The number of records in the ClientProperty arrays. | | [client_property_name](#client_property_name-property-amqpclassic-struct) | The table property's name. | | [client_property_value](#client_property_value-property-amqpclassic-struct) | The table property's value. | | [client_property_value_type](#client_property_value_type-property-amqpclassic-struct) | The table property's value type. | | [connected](#connected-property-amqpclassic-struct) | This property indicates whether the struct is connected. | | [firewall_auto_detect](#firewall_auto_detect-property-amqpclassic-struct) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_type](#firewall_type-property-amqpclassic-struct) | The type of firewall to connect through. | | [firewall_host](#firewall_host-property-amqpclassic-struct) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property-amqpclassic-struct) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property-amqpclassic-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_user](#firewall_user-property-amqpclassic-struct) | A username if authentication is to be used when connecting through a firewall. | | [heartbeat](#heartbeat-property-amqpclassic-struct) | The heartbeat timeout value. | | [incoming_message_count](#incoming_message_count-property-amqpclassic-struct) | The number of records in the IncomingMessage arrays. | | [incoming_message_app_id](#incoming_message_app_id-property-amqpclassic-struct) | The Id of the application that created the message. | | [incoming_message_body](#incoming_message_body-property-amqpclassic-struct) | The message body. | | [incoming_message_channel_name](#incoming_message_channel_name-property-amqpclassic-struct) | The name of the channel the message is associated with. | | [incoming_message_content_encoding](#incoming_message_content_encoding-property-amqpclassic-struct) | The content encoding of the message's body. | | [incoming_message_content_type](#incoming_message_content_type-property-amqpclassic-struct) | The content type (MIME type) of the message's body. | | [incoming_message_correlation_id](#incoming_message_correlation_id-property-amqpclassic-struct) | The correlation Id of the message. | | [incoming_message_delivery_mode](#incoming_message_delivery_mode-property-amqpclassic-struct) | The delivery mode of the message. | | [incoming_message_expiration](#incoming_message_expiration-property-amqpclassic-struct) | The time-to-live value for this message. | | [incoming_message_headers](#incoming_message_headers-property-amqpclassic-struct) | Headers associated with the message. | | [incoming_message_id](#incoming_message_id-property-amqpclassic-struct) | The unique Id of the message. | | [incoming_message_message_type](#incoming_message_message_type-property-amqpclassic-struct) | The message's type. | | [incoming_message_priority](#incoming_message_priority-property-amqpclassic-struct) | The priority of the message. | | [incoming_message_reply_to](#incoming_message_reply_to-property-amqpclassic-struct) | The address to send replies to for the message. | | [incoming_message_timestamp](#incoming_message_timestamp-property-amqpclassic-struct) | The message's timestamp. | | [incoming_message_user_id](#incoming_message_user_id-property-amqpclassic-struct) | The identity of the user responsible for producing the message. | | [local_host](#local_host-property-amqpclassic-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [local_port](#local_port-property-amqpclassic-struct) | The TCP port in the local host where the struct binds. | | [message_app_id](#message_app_id-property-amqpclassic-struct) | The Id of the application that created the message. | | [message_body](#message_body-property-amqpclassic-struct) | The message body. | | [message_channel_name](#message_channel_name-property-amqpclassic-struct) | The name of the channel the message is associated with. | | [message_content_encoding](#message_content_encoding-property-amqpclassic-struct) | The content encoding of the message's body. | | [message_content_type](#message_content_type-property-amqpclassic-struct) | The content type (MIME type) of the message's body. | | [message_correlation_id](#message_correlation_id-property-amqpclassic-struct) | The correlation Id of the message. | | [message_delivery_mode](#message_delivery_mode-property-amqpclassic-struct) | The delivery mode of the message. | | [message_expiration](#message_expiration-property-amqpclassic-struct) | The time-to-live value for this message. | | [message_headers](#message_headers-property-amqpclassic-struct) | Headers associated with the message. | | [message_id](#message_id-property-amqpclassic-struct) | The unique Id of the message. | | [message_type](#message_type-property-amqpclassic-struct) | The message's type. | | [message_priority](#message_priority-property-amqpclassic-struct) | The priority of the message. | | [message_reply_to](#message_reply_to-property-amqpclassic-struct) | The address to send replies to for the message. | | [message_timestamp](#message_timestamp-property-amqpclassic-struct) | The message's timestamp. | | [message_user_id](#message_user_id-property-amqpclassic-struct) | The identity of the user responsible for producing the message. | | [outgoing_message_count](#outgoing_message_count-property-amqpclassic-struct) | The number of records in the OutgoingMessage arrays. | | [outgoing_message_app_id](#outgoing_message_app_id-property-amqpclassic-struct) | The Id of the application that created the message. | | [outgoing_message_body](#outgoing_message_body-property-amqpclassic-struct) | The message body. | | [outgoing_message_channel_name](#outgoing_message_channel_name-property-amqpclassic-struct) | The name of the channel the message is associated with. | | [outgoing_message_content_encoding](#outgoing_message_content_encoding-property-amqpclassic-struct) | The content encoding of the message's body. | | [outgoing_message_content_type](#outgoing_message_content_type-property-amqpclassic-struct) | The content type (MIME type) of the message's body. | | [outgoing_message_correlation_id](#outgoing_message_correlation_id-property-amqpclassic-struct) | The correlation Id of the message. | | [outgoing_message_delivery_mode](#outgoing_message_delivery_mode-property-amqpclassic-struct) | The delivery mode of the message. | | [outgoing_message_expiration](#outgoing_message_expiration-property-amqpclassic-struct) | The time-to-live value for this message. | | [outgoing_message_headers](#outgoing_message_headers-property-amqpclassic-struct) | Headers associated with the message. | | [outgoing_message_id](#outgoing_message_id-property-amqpclassic-struct) | The unique Id of the message. | | [outgoing_message_message_type](#outgoing_message_message_type-property-amqpclassic-struct) | The message's type. | | [outgoing_message_priority](#outgoing_message_priority-property-amqpclassic-struct) | The priority of the message. | | [outgoing_message_reply_to](#outgoing_message_reply_to-property-amqpclassic-struct) | The address to send replies to for the message. | | [outgoing_message_timestamp](#outgoing_message_timestamp-property-amqpclassic-struct) | The message's timestamp. | | [outgoing_message_user_id](#outgoing_message_user_id-property-amqpclassic-struct) | The identity of the user responsible for producing the message. | | [password](#password-property-amqpclassic-struct) | A password to use for SASL authentication. | | [queue_message_count](#queue_message_count-property-amqpclassic-struct) | The message count returned by various queue operations. | | [received_message_app_id](#received_message_app_id-property-amqpclassic-struct) | The Id of the application that created the message. | | [received_message_body](#received_message_body-property-amqpclassic-struct) | The message body. | | [received_message_channel_name](#received_message_channel_name-property-amqpclassic-struct) | The name of the channel the message is associated with. | | [received_message_content_encoding](#received_message_content_encoding-property-amqpclassic-struct) | The content encoding of the message's body. | | [received_message_content_type](#received_message_content_type-property-amqpclassic-struct) | The content type (MIME type) of the message's body. | | [received_message_correlation_id](#received_message_correlation_id-property-amqpclassic-struct) | The correlation Id of the message. | | [received_message_delivery_mode](#received_message_delivery_mode-property-amqpclassic-struct) | The delivery mode of the message. | | [received_message_expiration](#received_message_expiration-property-amqpclassic-struct) | The time-to-live value for this message. | | [received_message_headers](#received_message_headers-property-amqpclassic-struct) | Headers associated with the message. | | [received_message_id](#received_message_id-property-amqpclassic-struct) | The unique Id of the message. | | [received_message_message_type](#received_message_message_type-property-amqpclassic-struct) | The message's type. | | [received_message_priority](#received_message_priority-property-amqpclassic-struct) | The priority of the message. | | [received_message_reply_to](#received_message_reply_to-property-amqpclassic-struct) | The address to send replies to for the message. | | [received_message_timestamp](#received_message_timestamp-property-amqpclassic-struct) | The message's timestamp. | | [received_message_user_id](#received_message_user_id-property-amqpclassic-struct) | The identity of the user responsible for producing the message. | | [remote_host](#remote_host-property-amqpclassic-struct) | This property includes the address of the remote host. Domain names are resolved to IP addresses. | | [remote_port](#remote_port-property-amqpclassic-struct) | The port of the AMQP server (default is 5672). The default port for SSL is 5671. | | [server_property_count](#server_property_count-property-amqpclassic-struct) | The number of records in the ServerProperty arrays. | | [server_property_name](#server_property_name-property-amqpclassic-struct) | The table property's name. | | [server_property_value](#server_property_value-property-amqpclassic-struct) | The table property's value. | | [server_property_value_type](#server_property_value_type-property-amqpclassic-struct) | The table property's value type. | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property-amqpclassic-struct) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property-amqpclassic-struct) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property-amqpclassic-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property-amqpclassic-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property-amqpclassic-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property-amqpclassic-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property-amqpclassic-struct) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-amqpclassic-struct) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-amqpclassic-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property-amqpclassic-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property-amqpclassic-struct) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property-amqpclassic-struct) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property-amqpclassic-struct) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property-amqpclassic-struct) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property-amqpclassic-struct) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-amqpclassic-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-amqpclassic-struct) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property-amqpclassic-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property-amqpclassic-struct) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property-amqpclassic-struct) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property-amqpclassic-struct) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-amqpclassic-struct) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-amqpclassic-struct) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property-amqpclassic-struct) | The certificate's version number. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-amqpclassic-struct) | The certificate (PEM/Base64 encoded). | | [ssl_cert_effective_date](#ssl_cert_effective_date-property-amqpclassic-struct) | The date on which this certificate becomes valid. | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-amqpclassic-struct) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-amqpclassic-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-amqpclassic-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-amqpclassic-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-amqpclassic-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property-amqpclassic-struct) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property-amqpclassic-struct) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-amqpclassic-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-amqpclassic-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property-amqpclassic-struct) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-amqpclassic-struct) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-amqpclassic-struct) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property-amqpclassic-struct) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-amqpclassic-struct) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property-amqpclassic-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_cert_store_type](#ssl_cert_store_type-property-amqpclassic-struct) | The type of certificate store for this certificate. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-amqpclassic-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-amqpclassic-struct) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-amqpclassic-struct) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-amqpclassic-struct) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property-amqpclassic-struct) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-amqpclassic-struct) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property-amqpclassic-struct) | The certificate's version number. | | [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) | The subject of the certificate used for client authentication. | | [ssl_cert_encoded](#ssl_cert_encoded-property-amqpclassic-struct) | The certificate (PEM/Base64 encoded). | | [ssl_enabled](#ssl_enabled-property-amqpclassic-struct) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. | | [ssl_provider](#ssl_provider-property-amqpclassic-struct) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property-amqpclassic-struct) | The date on which this certificate becomes valid. | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property-amqpclassic-struct) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property-amqpclassic-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property-amqpclassic-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property-amqpclassic-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property-amqpclassic-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property-amqpclassic-struct) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-amqpclassic-struct) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-amqpclassic-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property-amqpclassic-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property-amqpclassic-struct) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property-amqpclassic-struct) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property-amqpclassic-struct) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property-amqpclassic-struct) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property-amqpclassic-struct) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-amqpclassic-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-amqpclassic-struct) | The type of certificate store for this certificate. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property-amqpclassic-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property-amqpclassic-struct) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property-amqpclassic-struct) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property-amqpclassic-struct) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property-amqpclassic-struct) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-amqpclassic-struct) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property-amqpclassic-struct) | The certificate's version number. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) | The subject of the certificate used for client authentication. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-amqpclassic-struct) | The certificate (PEM/Base64 encoded). | | [timeout](#timeout-property-amqpclassic-struct) | This property includes the timeout for the struct. | | [user](#user-property-amqpclassic-struct) | A username to use for SASL authentication. | | [virtual_host](#virtual_host-property-amqpclassic-struct) | The virtual host to connect to. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [bind_queue](#bind_queue-method-amqpclassic-struct) | Binds a queue to an exchange. | | [cancel_consume](#cancel_consume-method-amqpclassic-struct) | Cancels an existing consumer. | | [close_channel](#close_channel-method-amqpclassic-struct) | Closes a channel. | | [commit_transaction](#commit_transaction-method-amqpclassic-struct) | Commits the current transaction for a channel. | | [config](#config-method-amqpclassic-struct) | Sets or retrieves a configuration setting. | | [connect](#connect-method-amqpclassic-struct) | This method connects to a remote host. | | [connect_to](#connect_to-method-amqpclassic-struct) | This method connects to a remote host. | | [consume](#consume-method-amqpclassic-struct) | Starts a new consumer for a given queue. | | [create_channel](#create_channel-method-amqpclassic-struct) | Creates a new channel. | | [declare_exchange](#declare_exchange-method-amqpclassic-struct) | Verifies that an exchange exists, potentially creating it if necessary. | | [declare_queue](#declare_queue-method-amqpclassic-struct) | Verifies that a queue exists, potentially creating it if necessary. | | [delete_exchange](#delete_exchange-method-amqpclassic-struct) | Deletes an exchange. | | [delete_queue](#delete_queue-method-amqpclassic-struct) | Deletes a queue. | | [disconnect](#disconnect-method-amqpclassic-struct) | This method disconnects from the remote host. | | [do_events](#do_events-method-amqpclassic-struct) | This method processes events from the internal message queue. | | [enable_publish_confirms](#enable_publish_confirms-method-amqpclassic-struct) | Enables publish confirmations mode for a channel. | | [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) | Enables transaction mode for a channel. | | [interrupt](#interrupt-method-amqpclassic-struct) | Interrupt the current action and disconnects from the remote host. | | [publish_message](#publish_message-method-amqpclassic-struct) | Publishes a message. | | [purge_queue](#purge_queue-method-amqpclassic-struct) | Purges all messages from a queue. | | [recover](#recover-method-amqpclassic-struct) | Request that the server redeliver all messages on a given channel that have not been acknowledged. | | [reset](#reset-method-amqpclassic-struct) | This method will reset the struct. | | [reset_message](#reset_message-method-amqpclassic-struct) | Resets the Message properties. | | [retrieve_message](#retrieve_message-method-amqpclassic-struct) | Attempts to retrieve a message from a given queue. | | [rollback_transaction](#rollback_transaction-method-amqpclassic-struct) | Rolls back the current transaction for a channel. | | [set_channel_accept](#set_channel_accept-method-amqpclassic-struct) | Disables or enables message acceptance for a given channel. | | [set_qo_s](#set_qo_s-method-amqpclassic-struct) | Requests a specific quality of service (QoS). | | [unbind_queue](#unbind_queue-method-amqpclassic-struct) | Removes a previously-created queue binding. | ## 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.* | | | | --- | --- | | [on_channel_ready_to_send](#on_channel_ready_to_send-event-amqpclassic-struct) | Fires when a channel is ready to send messages. | | [on_connected](#on_connected-event-amqpclassic-struct) | Fired immediately after a connection completes (or fails). | | [on_connection_status](#on_connection_status-event-amqpclassic-struct) | Fired to indicate changes in the connection state. | | [on_disconnected](#on_disconnected-event-amqpclassic-struct) | Fired when a connection is closed. | | [on_error](#on_error-event-amqpclassic-struct) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event-amqpclassic-struct) | Fires once for each log message. | | [on_message_in](#on_message_in-event-amqpclassic-struct) | Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue. | | [on_message_out](#on_message_out-event-amqpclassic-struct) | Fires when a message is published. | | [on_message_returned](#on_message_returned-event-amqpclassic-struct) | Fires if a previously published message is returned by the server due to it being undeliverable. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event-amqpclassic-struct) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event-amqpclassic-struct) | Fired when secure connection progress messages are available. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. | | [ConsumerTag](#ConsumerTag) | The consumer tag associated with the most recently created consumer. | | [Locale](#Locale) | The desired message locale to use. | | [Locales](#Locales) | The message locales supported by the server. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxChannelCount](#MaxChannelCount) | The maximum number of channels. | | [MaxFrameSize](#MaxFrameSize) | The maximum frame size. | | [Mechanisms](#Mechanisms) | The authentication mechanisms supported by the server. | | [NackMultiple](#NackMultiple) | Whether negative acknowledgments should be cumulative or not. | | [ProtocolVersion](#ProtocolVersion) | The AMQP protocol version to conform to. | | [QueueConsumerCount](#QueueConsumerCount) | The consumer count associated with the most recently created (or verified) queue. | | [QueueName](#QueueName) | The queue name associated with the most recently created (or verified) queue. | | [RabbitMQCompatible](#RabbitMQCompatible) | Whether to operate in a mode compatible with RabbitMQ. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the struct binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # argument_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The number of records in the Argument arrays. ## Syntax *Rust Syntax* ```text fn argument_count(&self ) -> Result fn set_argument_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [argument_name](#argument_name-property-amqpclassic-struct) - [argument_value](#argument_value-property-amqpclassic-struct) - [argument_value_type](#argument_value_type-property-amqpclassic-struct) The array indices start at *0* and end at *argument_count - 1*. ## Data Type i32 # argument_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's name. ## Syntax *Rust Syntax* ```text fn argument_name(&self , ArgumentIndex : i32) -> Result fn set_argument_name(&self, ArgumentIndex : i32, value : &str) -> Option fn set_argument_name_ref(&self, ArgumentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The table field's name. This property specifies the table field's name. The name must be an ASCII string that: - Starts with an ASCII letter, *$*, or *$* character. - Only contains ASCII letters, digits, underscores, *$*, and *$* characters. - Is unique among all sibling table field [argument_name](#argument_name-property-amqpclassic-struct)s. - Is no longer than 128 characters. The *ArgumentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ArgumentCount](#argument_count-property-amqpclassic-struct) property. ## Data Type String # argument_value property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's value. ## Syntax *Rust Syntax* ```text fn argument_value(&self , ArgumentIndex : i32) -> Result fn set_argument_value(&self, ArgumentIndex : i32, value : &str) -> Option fn set_argument_value_ref(&self, ArgumentIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The table field's value. This property specifies the table field's value. The *ArgumentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ArgumentCount](#argument_count-property-amqpclassic-struct) property. ## Data Type String # argument_value_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's value type. ## Syntax *Rust Syntax* ```text fn argument_value_type(&self , ArgumentIndex : i32) -> Result fn set_argument_value_type(&self, ArgumentIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // Boolean1 // Byte2 // Ubyte3 // Short4 // Ushort5 // Int6 // Uint7 // Long8 // Ulong9 // Float10 // Double11 // Decimal12 // Sstring13 // String14 // Array15 // Timestamp16 // Table17 // Null ``` ## Default Value 17 ## Remarks The table field's value type. This property specifies the table field's value type (and thus, the format of the data in the [argument_value](#argument_value-property-amqpclassic-struct) property). Acceptable value types are: | Value Type | JSON Value Type | Description | Value Format | | --- | --- | --- | --- | | fvtBoolean (0) | boolean | Boolean | "True" or "False" | | fvtByte (1) | byte | Byte | -128 to 127 | | fvtUbyte (2) | ubyte | Unsigned byte | 0 to 255 | | fvtShort (3) | short | Short | -32768 to 32767 | | fvtUshort (4) | ushort | Unsigned short | 0 to 65535 | | fvtInt (5) | int | Integer | -2147483648 to 2147483647 | | fvtUint (6) | uint | Unsigned integer | 0 to 4294967295 | | fvtLong (7) | long | Long | -9223372036854775808 to 9223372036854775807 | | fvtUlong (8) | ulong | Unsigned long | 0 to 18446744073709551615 | | fvtFloat (9) | float | Float | IEEE 754 32-bit floating point number | | fvtDouble (10) | double | Double | IEEE 754 64-bit floating point number | | fvtDecimal (11) | decimal | Decimal | Hex-encoded byte string | | fvtSstring (12) | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | fvtString (13) | string | String | String data | | fvtArray (14) | array | Array | JSON array of type-value pairs | | fvtTimestamp (15) | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | fvtTable (16) | table | Table | JSON object containing name-type-value tuples | | fvtNull (17 - default) | null | Null | N/A ([argument_value](#argument_value-property-amqpclassic-struct) is ignored) | NOTE: The *fvtUlong (8)* and *fvtSstring (12)* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. For the *fvtArray (14)* value type, the [argument_value](#argument_value-property-amqpclassic-struct) should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` For the *fvtTable (16)* value type, the [argument_value](#argument_value-property-amqpclassic-struct) should be specified as a JSON object containing name-type-value tuples; for example: ```text { { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } } ``` Notes regarding *fvtArray (14)* and *fvtTable (16)* type [argument_value](#argument_value-property-amqpclassic-struct)s: - All "type" fields in the JSON content must be set to one of the value types in the table above. - For *fvtTable (16)* type [argument_value](#argument_value-property-amqpclassic-struct)s, all "name" fields must adhere to the rules described by the [argument_key](#AMQPClassic_p_ArgumentKey) documentation. - Nesting and mixing multiple levels of arrays and tables in the JSON is allowed. The *ArgumentIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ArgumentCount](#argument_count-property-amqpclassic-struct) property. ## Data Type i32 # auth_scheme property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The authentication scheme to use when connecting. ## Syntax *Rust Syntax* ```text fn auth_scheme(&self ) -> Result fn set_auth_scheme(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // SASLAnonymous2 // SASLPlain3 // SASLExternal ``` ## Default Value 2 ## Remarks This property controls what authentication scheme the struct should use when connecting to the remote host. Valid values are: - smNone (0) - smSASLAnonymous (1) - smSASLPlain (2) - Default - smSASLExternal (3) ## Data Type i32 # channel_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The number of records in the Channel arrays. ## Syntax *Rust Syntax* ```text fn channel_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [channel_accept](#channel_accept-property-amqpclassic-struct) - [channel_mode](#channel_mode-property-amqpclassic-struct) - [channel_name](#channel_name-property-amqpclassic-struct) - [channel_ready_to_send](#channel_ready_to_send-property-amqpclassic-struct) The array indices start at *0* and end at *channel_count - 1*. This property is read-only. ## Data Type i32 # channel_accept property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Whether the channel is currently accepting new messages from the server. ## Syntax *Rust Syntax* ```text fn channel_accept(&self , ChannelIndex : i32) -> Result ``` ## Default Value true ## Remarks Whether the channel is currently accepting new messages from the server. This property reflects whether the channel is currently accepting new messages from the server. When the channel is created, this property is *True* by default. The [set_channel_accept](#set_channel_accept-method-amqpclassic-struct) method can be used to disable and re-enable message acceptance at any time; refer to that method for more information. The *ChannelIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChannelCount](#channel_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type bool # channel_mode property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) What mode the channel is operating in. ## Syntax *Rust Syntax* ```text fn channel_mode(&self , ChannelIndex : i32) -> Result ``` ## Possible Values ```text 0 // Normal1 // Transactional2 // PublishConfirms ``` ## Default Value 0 ## Remarks What mode the channel is operating in. This property reflects what mode the channel is operating in. Possible values are: - *cmtNormal (0 - default)*: Normal mode. - *cmtTransactional (1)*: Transaction mode. - *cmtPublishConfirms (2)*: Publish confirmations mode. All channels are in normal mode when they are created; there's nothing special about a channel in normal mode. Channels can be put in transaction mode using the [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) method. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back. Channels can be put in publish confirmations mode using the [enable_publish_confirms](#enable_publish_confirms-method-amqpclassic-struct) method. While a channel is in publish confirmations mode, the server will acknowledge each message published by the struct. The struct will wait to fire the [on_message_out](#on_message_out-event-amqpclassic-struct) event until it receives this acknowledgment. (Note that this mode is only available when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled.) NOTE: Switching a channel to transaction or publish confirmations mode is a permanent action; the channel will then remain in that mode for the remainder of its lifetime. The *ChannelIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChannelCount](#channel_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i32 # channel_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the channel. ## Syntax *Rust Syntax* ```text fn channel_name(&self , ChannelIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the channel. This property reflects the name of the channel. The *ChannelIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChannelCount](#channel_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # channel_ready_to_send property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Whether the channel is ready to send a message. ## Syntax *Rust Syntax* ```text fn channel_ready_to_send(&self , ChannelIndex : i32) -> Result ``` ## Default Value true ## Remarks Whether the channel is ready to send a message. This property reflects whether the channel is currently ready to send a message or not. The *ChannelIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChannelCount](#channel_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type bool # client_property_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The number of records in the ClientProperty arrays. ## Syntax *Rust Syntax* ```text fn client_property_count(&self ) -> Result fn set_client_property_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [client_property_name](#client_property_name-property-amqpclassic-struct) - [client_property_value](#client_property_value-property-amqpclassic-struct) - [client_property_value_type](#client_property_value_type-property-amqpclassic-struct) The array indices start at *0* and end at *client_property_count - 1*. ## Data Type i32 # client_property_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's name. ## Syntax *Rust Syntax* ```text fn client_property_name(&self , ClientPropertyIndex : i32) -> Result fn set_client_property_name(&self, ClientPropertyIndex : i32, value : &str) -> Option fn set_client_property_name_ref(&self, ClientPropertyIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The table field's name. This property specifies the table field's name. The name must be an ASCII string that: - Starts with an ASCII letter, *$*, or *$* character. - Only contains ASCII letters, digits, underscores, *$*, and *$* characters. - Is unique among all sibling table field [client_property_name](#client_property_name-property-amqpclassic-struct)s. - Is no longer than 128 characters. The *ClientPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientPropertyCount](#client_property_count-property-amqpclassic-struct) property. ## Data Type String # client_property_value property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's value. ## Syntax *Rust Syntax* ```text fn client_property_value(&self , ClientPropertyIndex : i32) -> Result fn set_client_property_value(&self, ClientPropertyIndex : i32, value : &str) -> Option fn set_client_property_value_ref(&self, ClientPropertyIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The table field's value. This property specifies the table field's value. The *ClientPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientPropertyCount](#client_property_count-property-amqpclassic-struct) property. ## Data Type String # client_property_value_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's value type. ## Syntax *Rust Syntax* ```text fn client_property_value_type(&self , ClientPropertyIndex : i32) -> Result fn set_client_property_value_type(&self, ClientPropertyIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // Boolean1 // Byte2 // Ubyte3 // Short4 // Ushort5 // Int6 // Uint7 // Long8 // Ulong9 // Float10 // Double11 // Decimal12 // Sstring13 // String14 // Array15 // Timestamp16 // Table17 // Null ``` ## Default Value 17 ## Remarks The table field's value type. This property specifies the table field's value type (and thus, the format of the data in the [client_property_value](#client_property_value-property-amqpclassic-struct) property). Acceptable value types are: | Value Type | JSON Value Type | Description | Value Format | | --- | --- | --- | --- | | fvtBoolean (0) | boolean | Boolean | "True" or "False" | | fvtByte (1) | byte | Byte | -128 to 127 | | fvtUbyte (2) | ubyte | Unsigned byte | 0 to 255 | | fvtShort (3) | short | Short | -32768 to 32767 | | fvtUshort (4) | ushort | Unsigned short | 0 to 65535 | | fvtInt (5) | int | Integer | -2147483648 to 2147483647 | | fvtUint (6) | uint | Unsigned integer | 0 to 4294967295 | | fvtLong (7) | long | Long | -9223372036854775808 to 9223372036854775807 | | fvtUlong (8) | ulong | Unsigned long | 0 to 18446744073709551615 | | fvtFloat (9) | float | Float | IEEE 754 32-bit floating point number | | fvtDouble (10) | double | Double | IEEE 754 64-bit floating point number | | fvtDecimal (11) | decimal | Decimal | Hex-encoded byte string | | fvtSstring (12) | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | fvtString (13) | string | String | String data | | fvtArray (14) | array | Array | JSON array of type-value pairs | | fvtTimestamp (15) | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | fvtTable (16) | table | Table | JSON object containing name-type-value tuples | | fvtNull (17 - default) | null | Null | N/A ([client_property_value](#client_property_value-property-amqpclassic-struct) is ignored) | NOTE: The *fvtUlong (8)* and *fvtSstring (12)* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. For the *fvtArray (14)* value type, the [client_property_value](#client_property_value-property-amqpclassic-struct) should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` For the *fvtTable (16)* value type, the [client_property_value](#client_property_value-property-amqpclassic-struct) should be specified as a JSON object containing name-type-value tuples; for example: ```text { { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } } ``` Notes regarding *fvtArray (14)* and *fvtTable (16)* type [client_property_value](#client_property_value-property-amqpclassic-struct)s: - All "type" fields in the JSON content must be set to one of the value types in the table above. - For *fvtTable (16)* type [client_property_value](#client_property_value-property-amqpclassic-struct)s, all "name" fields must adhere to the rules described by the [client_property_key](#AMQPClassic_p_ClientPropertyKey) documentation. - Nesting and mixing multiple levels of arrays and tables in the JSON is allowed. The *ClientPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ClientPropertyCount](#client_property_count-property-amqpclassic-struct) property. ## Data Type i32 # connected property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This property indicates whether the struct is connected. ## Syntax *Rust Syntax* ```text fn connected(&self ) -> Result ``` ## Default Value false ## Remarks This property indicates whether the struct is connected to the remote host. Use the [connect](#connect-method-amqpclassic-struct) and [disconnect](#disconnect-method-amqpclassic-struct) methods to manage the connection. This property is read-only. ## Data Type bool # firewall_auto_detect property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Rust Syntax* ```text fn firewall_auto_detect(&self ) -> Result fn set_firewall_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type bool # firewall_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The type of firewall to connect through. ## Syntax *Rust Syntax* ```text fn firewall_type(&self ) -> Result fn set_firewall_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property-amqpclassic-struct) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-amqpclassic-struct) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-amqpclassic-struct) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-amqpclassic-struct) is set to 1080. | ## Data Type i32 # firewall_host property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name or IP address of the firewall (optional). ## Syntax *Rust Syntax* ```text fn firewall_host(&self ) -> Result fn set_firewall_host(&self, value : &str) -> Option fn set_firewall_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A password if authentication is to be used when connecting through the firewall. ## Syntax *Rust Syntax* ```text fn firewall_password(&self ) -> Result fn set_firewall_password(&self, value : &str) -> Option fn set_firewall_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-amqpclassic-struct) is specified, the [firewall_user](#firewall_user-property-amqpclassic-struct) and [firewall_password](#firewall_password-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Rust Syntax* ```text fn firewall_port(&self ) -> Result fn set_firewall_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-amqpclassic-struct). See the description of the [firewall_host](#firewall_host-property-amqpclassic-struct) property for details. NOTE: This property is set automatically when [firewall_firewall_type](#AMQPClassic_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#AMQPClassic_p_FirewallFirewallType) property for details. ## Data Type i32 # firewall_user property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A username if authentication is to be used when connecting through a firewall. ## Syntax *Rust Syntax* ```text fn firewall_user(&self ) -> Result fn set_firewall_user(&self, value : &str) -> Option fn set_firewall_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-amqpclassic-struct) is specified, this property and the [firewall_password](#firewall_password-property-amqpclassic-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type String # heartbeat property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The heartbeat timeout value. ## Syntax *Rust Syntax* ```text fn heartbeat(&self ) -> Result fn set_heartbeat(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property specifies the heartbeat timeout value, in seconds. Heartbeats are disabled if set to 0 (default). Before connecting, this property can be set to indicate the desired heartbeat timeout value. During the connection process, the struct and the server will compare their desired heartbeat values and choose the lower one. Once connected, this property will reflect the agreed-upon heartbeat value. While the connection is idle, heartbeats are sent by both the struct and the server approximately once every (heartbeat / 2) seconds. If either side has not received a heartbeat (or other transmission) for ~heartbeat seconds, it will consider the other side unreachable and close the connection. This setting cannot be changed while connected. ## Data Type i32 # incoming_message_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The number of records in the IncomingMessage arrays. ## Syntax *Rust Syntax* ```text fn incoming_message_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [incoming_message_app_id](#incoming_message_app_id-property-amqpclassic-struct) - [incoming_message_body](#incoming_message_body-property-amqpclassic-struct) - [incoming_message_channel_name](#incoming_message_channel_name-property-amqpclassic-struct) - [incoming_message_content_encoding](#incoming_message_content_encoding-property-amqpclassic-struct) - [incoming_message_content_type](#incoming_message_content_type-property-amqpclassic-struct) - [incoming_message_correlation_id](#incoming_message_correlation_id-property-amqpclassic-struct) - [incoming_message_delivery_mode](#incoming_message_delivery_mode-property-amqpclassic-struct) - [incoming_message_expiration](#incoming_message_expiration-property-amqpclassic-struct) - [incoming_message_headers](#incoming_message_headers-property-amqpclassic-struct) - [incoming_message_id](#incoming_message_id-property-amqpclassic-struct) - [incoming_message_message_type](#incoming_message_message_type-property-amqpclassic-struct) - [incoming_message_priority](#incoming_message_priority-property-amqpclassic-struct) - [incoming_message_reply_to](#incoming_message_reply_to-property-amqpclassic-struct) - [incoming_message_timestamp](#incoming_message_timestamp-property-amqpclassic-struct) - [incoming_message_user_id](#incoming_message_user_id-property-amqpclassic-struct) The array indices start at *0* and end at *incoming_message_count - 1*. This property is read-only. ## Data Type i32 # incoming_message_app_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The Id of the application that created the message. ## Syntax *Rust Syntax* ```text fn incoming_message_app_id(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The Id of the application that created the message. This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_body property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message body. ## Syntax *Rust Syntax* ```text fn incoming_message_body(&self , IncomingMessageIndex : i32) -> Result, IPWorksIoTError> ``` ## Default Value "" ## Remarks The message body. This property holds the body of the message. It may be empty. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type Vec # incoming_message_channel_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the channel the message is associated with. ## Syntax *Rust Syntax* ```text fn incoming_message_channel_name(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the channel the message is associated with. This property reflects the name of the channel which the message is associated with; it is populated automatically by the struct. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_content_encoding property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content encoding of the message's body. ## Syntax *Rust Syntax* ```text fn incoming_message_content_encoding(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The content encoding of the message's body. This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_content_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content type (MIME type) of the message's body. ## Syntax *Rust Syntax* ```text fn incoming_message_content_type(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The content type (MIME type) of the message's body. This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_correlation_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The correlation Id of the message. ## Syntax *Rust Syntax* ```text fn incoming_message_correlation_id(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The correlation Id of the message. This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_delivery_mode property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The delivery mode of the message. ## Syntax *Rust Syntax* ```text fn incoming_message_delivery_mode(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The delivery mode of the message. This property holds the delivery mode of the message; possible values are: - *0*: Unspecified. - *1*: Non-persistent; the message may be lost if the server encounters an error. - *2*: Persistent; the message will not be lost, even in case of server errors. The default is 0, which indicates that the message does not have an explicit delivery mode set. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i32 # incoming_message_expiration property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The time-to-live value for this message. ## Syntax *Rust Syntax* ```text fn incoming_message_expiration(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_headers property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Headers associated with the message. ## Syntax *Rust Syntax* ```text fn incoming_message_headers(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks Headers associated with the message. This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set. This property must be specified as a JSON object containing name-type-value tuples; for example: ```text [ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ] ``` All "name" values must be ASCII strings that: - Start with an ASCII letter, *$*, or *$* character. - Only contain ASCII letters, digits, underscores, *$*, and *$* characters. - Are unique among their siblings. - Are no longer than 128 characters. The following table describes all valid "type" values, and how to format the "value" field for each: | JSON Value Type | Description | Value Format | | --- | --- | --- | | boolean | Boolean | "True" or "False" | | byte | Byte | -128 to 127 | | ubyte | Unsigned byte | 0 to 255 | | short | Short | -32768 to 32767 | | ushort | Unsigned short | 0 to 65535 | | int | Integer | -2147483648 to 2147483647 | | uint | Unsigned integer | 0 to 4294967295 | | long | Long | -9223372036854775808 to 9223372036854775807 | | ulong | Unsigned long | 0 to 18446744073709551615 | | float | Float | IEEE 754 32-bit floating point number | | double | Double | IEEE 754 64-bit floating point number | | decimal | Decimal | Hex-encoded byte string | | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | string | String | String data | | array | Array | JSON array of type-value pairs | | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | table | Table | JSON object containing name-type-value tuples | | null | Null | N/A ([incoming_message_value](#AMQPClassic_p_IncomingMessageValue) is ignored) | NOTE: The *ulong* and *sstring* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. Headers of the *table* type should be specified in the same manner as shown above, while headers of the *array* type should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` Nesting and mixing multiple levels of arrays and tables is allowed. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The unique Id of the message. ## Syntax *Rust Syntax* ```text fn incoming_message_id(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The unique Id of the message. This property holds the unique Id of the message. It may be empty if the message does not have a unique Id. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_message_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's type. ## Syntax *Rust Syntax* ```text fn incoming_message_message_type(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The message's type. This property holds the type of the message. It may be empty if the message does not have a type set. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_priority property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The priority of the message. ## Syntax *Rust Syntax* ```text fn incoming_message_priority(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The priority of the message. This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i32 # incoming_message_reply_to property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The address to send replies to for the message. ## Syntax *Rust Syntax* ```text fn incoming_message_reply_to(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The address to send replies to for the message. This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # incoming_message_timestamp property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's timestamp. ## Syntax *Rust Syntax* ```text fn incoming_message_timestamp(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The message's timestamp. This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i64 # incoming_message_user_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The identity of the user responsible for producing the message. ## Syntax *Rust Syntax* ```text fn incoming_message_user_id(&self , IncomingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The identity of the user responsible for producing the message. This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message. A message's user Id *may* be used for verification or authentication by the server and/or the final consumer. This value must be specified as a string no longer than 255 characters. The *IncomingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [IncomingMessageCount](#incoming_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # local_host property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Rust Syntax* ```text fn local_host(&self ) -> Result fn set_local_host(&self, value : &str) -> Option fn set_local_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: local_host is not persistent. You must always set it in code, and never in the property window. ## Data Type String # local_port property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The TCP port in the local host where the struct binds. ## Syntax *Rust Syntax* ```text fn local_port(&self ) -> Result fn set_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the local_port property after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error. This property is useful when trying to connect to services that require a trusted port on the client side. ## Data Type i32 # message_app_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The Id of the application that created the message. ## Syntax *Rust Syntax* ```text fn message_app_id(&self ) -> Result fn set_message_app_id(&self, value : &str) -> Option fn set_message_app_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The Id of the application that created the message. This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_body property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message body. ## Syntax *Rust Syntax* ```text fn message_body(&self ) -> Result, IPWorksIoTError> fn set_message_body(&self, value : Vec) -> Option fn set_message_body_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The message body. This property holds the body of the message. It may be empty. ## Data Type Vec # message_channel_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the channel the message is associated with. ## Syntax *Rust Syntax* ```text fn message_channel_name(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the channel the message is associated with. This property reflects the name of the channel which the message is associated with; it is populated automatically by the struct. This property is read-only. ## Data Type String # message_content_encoding property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content encoding of the message's body. ## Syntax *Rust Syntax* ```text fn message_content_encoding(&self ) -> Result fn set_message_content_encoding(&self, value : &str) -> Option fn set_message_content_encoding_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The content encoding of the message's body. This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_content_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content type (MIME type) of the message's body. ## Syntax *Rust Syntax* ```text fn message_content_type(&self ) -> Result fn set_message_content_type(&self, value : &str) -> Option fn set_message_content_type_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The content type (MIME type) of the message's body. This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_correlation_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The correlation Id of the message. ## Syntax *Rust Syntax* ```text fn message_correlation_id(&self ) -> Result fn set_message_correlation_id(&self, value : &str) -> Option fn set_message_correlation_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The correlation Id of the message. This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_delivery_mode property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The delivery mode of the message. ## Syntax *Rust Syntax* ```text fn message_delivery_mode(&self ) -> Result fn set_message_delivery_mode(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The delivery mode of the message. This property holds the delivery mode of the message; possible values are: - *0*: Unspecified. - *1*: Non-persistent; the message may be lost if the server encounters an error. - *2*: Persistent; the message will not be lost, even in case of server errors. The default is 0, which indicates that the message does not have an explicit delivery mode set. ## Data Type i32 # message_expiration property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The time-to-live value for this message. ## Syntax *Rust Syntax* ```text fn message_expiration(&self ) -> Result fn set_message_expiration(&self, value : &str) -> Option fn set_message_expiration_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. ## Data Type String # message_headers property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Headers associated with the message. ## Syntax *Rust Syntax* ```text fn message_headers(&self ) -> Result fn set_message_headers(&self, value : &str) -> Option fn set_message_headers_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Headers associated with the message. This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set. This property must be specified as a JSON object containing name-type-value tuples; for example: ```text [ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ] ``` All "name" values must be ASCII strings that: - Start with an ASCII letter, *$*, or *$* character. - Only contain ASCII letters, digits, underscores, *$*, and *$* characters. - Are unique among their siblings. - Are no longer than 128 characters. The following table describes all valid "type" values, and how to format the "value" field for each: | JSON Value Type | Description | Value Format | | --- | --- | --- | | boolean | Boolean | "True" or "False" | | byte | Byte | -128 to 127 | | ubyte | Unsigned byte | 0 to 255 | | short | Short | -32768 to 32767 | | ushort | Unsigned short | 0 to 65535 | | int | Integer | -2147483648 to 2147483647 | | uint | Unsigned integer | 0 to 4294967295 | | long | Long | -9223372036854775808 to 9223372036854775807 | | ulong | Unsigned long | 0 to 18446744073709551615 | | float | Float | IEEE 754 32-bit floating point number | | double | Double | IEEE 754 64-bit floating point number | | decimal | Decimal | Hex-encoded byte string | | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | string | String | String data | | array | Array | JSON array of type-value pairs | | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | table | Table | JSON object containing name-type-value tuples | | null | Null | N/A ([message_value](#AMQPClassic_p_MessageValue) is ignored) | NOTE: The *ulong* and *sstring* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. Headers of the *table* type should be specified in the same manner as shown above, while headers of the *array* type should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` Nesting and mixing multiple levels of arrays and tables is allowed. ## Data Type String # message_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The unique Id of the message. ## Syntax *Rust Syntax* ```text fn message_id(&self ) -> Result fn set_message_id(&self, value : &str) -> Option fn set_message_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The unique Id of the message. This property holds the unique Id of the message. It may be empty if the message does not have a unique Id. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's type. ## Syntax *Rust Syntax* ```text fn message_type(&self ) -> Result fn set_message_type(&self, value : &str) -> Option fn set_message_type_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The message's type. This property holds the type of the message. It may be empty if the message does not have a type set. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_priority property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The priority of the message. ## Syntax *Rust Syntax* ```text fn message_priority(&self ) -> Result fn set_message_priority(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The priority of the message. This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent. ## Data Type i32 # message_reply_to property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The address to send replies to for the message. ## Syntax *Rust Syntax* ```text fn message_reply_to(&self ) -> Result fn set_message_reply_to(&self, value : &str) -> Option fn set_message_reply_to_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The address to send replies to for the message. This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set. This value must be specified as a string no longer than 255 characters. ## Data Type String # message_timestamp property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's timestamp. ## Syntax *Rust Syntax* ```text fn message_timestamp(&self ) -> Result fn set_message_timestamp(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks The message's timestamp. This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set. ## Data Type i64 # message_user_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The identity of the user responsible for producing the message. ## Syntax *Rust Syntax* ```text fn message_user_id(&self ) -> Result fn set_message_user_id(&self, value : &str) -> Option fn set_message_user_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The identity of the user responsible for producing the message. This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message. A message's user Id *may* be used for verification or authentication by the server and/or the final consumer. This value must be specified as a string no longer than 255 characters. ## Data Type String # outgoing_message_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The number of records in the OutgoingMessage arrays. ## Syntax *Rust Syntax* ```text fn outgoing_message_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [outgoing_message_app_id](#outgoing_message_app_id-property-amqpclassic-struct) - [outgoing_message_body](#outgoing_message_body-property-amqpclassic-struct) - [outgoing_message_channel_name](#outgoing_message_channel_name-property-amqpclassic-struct) - [outgoing_message_content_encoding](#outgoing_message_content_encoding-property-amqpclassic-struct) - [outgoing_message_content_type](#outgoing_message_content_type-property-amqpclassic-struct) - [outgoing_message_correlation_id](#outgoing_message_correlation_id-property-amqpclassic-struct) - [outgoing_message_delivery_mode](#outgoing_message_delivery_mode-property-amqpclassic-struct) - [outgoing_message_expiration](#outgoing_message_expiration-property-amqpclassic-struct) - [outgoing_message_headers](#outgoing_message_headers-property-amqpclassic-struct) - [outgoing_message_id](#outgoing_message_id-property-amqpclassic-struct) - [outgoing_message_message_type](#outgoing_message_message_type-property-amqpclassic-struct) - [outgoing_message_priority](#outgoing_message_priority-property-amqpclassic-struct) - [outgoing_message_reply_to](#outgoing_message_reply_to-property-amqpclassic-struct) - [outgoing_message_timestamp](#outgoing_message_timestamp-property-amqpclassic-struct) - [outgoing_message_user_id](#outgoing_message_user_id-property-amqpclassic-struct) The array indices start at *0* and end at *outgoing_message_count - 1*. This property is read-only. ## Data Type i32 # outgoing_message_app_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The Id of the application that created the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_app_id(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The Id of the application that created the message. This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_body property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message body. ## Syntax *Rust Syntax* ```text fn outgoing_message_body(&self , OutgoingMessageIndex : i32) -> Result, IPWorksIoTError> ``` ## Default Value "" ## Remarks The message body. This property holds the body of the message. It may be empty. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type Vec # outgoing_message_channel_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the channel the message is associated with. ## Syntax *Rust Syntax* ```text fn outgoing_message_channel_name(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the channel the message is associated with. This property reflects the name of the channel which the message is associated with; it is populated automatically by the struct. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_content_encoding property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content encoding of the message's body. ## Syntax *Rust Syntax* ```text fn outgoing_message_content_encoding(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The content encoding of the message's body. This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_content_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content type (MIME type) of the message's body. ## Syntax *Rust Syntax* ```text fn outgoing_message_content_type(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The content type (MIME type) of the message's body. This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_correlation_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The correlation Id of the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_correlation_id(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The correlation Id of the message. This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_delivery_mode property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The delivery mode of the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_delivery_mode(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The delivery mode of the message. This property holds the delivery mode of the message; possible values are: - *0*: Unspecified. - *1*: Non-persistent; the message may be lost if the server encounters an error. - *2*: Persistent; the message will not be lost, even in case of server errors. The default is 0, which indicates that the message does not have an explicit delivery mode set. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i32 # outgoing_message_expiration property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The time-to-live value for this message. ## Syntax *Rust Syntax* ```text fn outgoing_message_expiration(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_headers property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Headers associated with the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_headers(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks Headers associated with the message. This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set. This property must be specified as a JSON object containing name-type-value tuples; for example: ```text [ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ] ``` All "name" values must be ASCII strings that: - Start with an ASCII letter, *$*, or *$* character. - Only contain ASCII letters, digits, underscores, *$*, and *$* characters. - Are unique among their siblings. - Are no longer than 128 characters. The following table describes all valid "type" values, and how to format the "value" field for each: | JSON Value Type | Description | Value Format | | --- | --- | --- | | boolean | Boolean | "True" or "False" | | byte | Byte | -128 to 127 | | ubyte | Unsigned byte | 0 to 255 | | short | Short | -32768 to 32767 | | ushort | Unsigned short | 0 to 65535 | | int | Integer | -2147483648 to 2147483647 | | uint | Unsigned integer | 0 to 4294967295 | | long | Long | -9223372036854775808 to 9223372036854775807 | | ulong | Unsigned long | 0 to 18446744073709551615 | | float | Float | IEEE 754 32-bit floating point number | | double | Double | IEEE 754 64-bit floating point number | | decimal | Decimal | Hex-encoded byte string | | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | string | String | String data | | array | Array | JSON array of type-value pairs | | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | table | Table | JSON object containing name-type-value tuples | | null | Null | N/A ([outgoing_message_value](#AMQPClassic_p_OutgoingMessageValue) is ignored) | NOTE: The *ulong* and *sstring* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. Headers of the *table* type should be specified in the same manner as shown above, while headers of the *array* type should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` Nesting and mixing multiple levels of arrays and tables is allowed. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The unique Id of the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_id(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The unique Id of the message. This property holds the unique Id of the message. It may be empty if the message does not have a unique Id. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_message_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's type. ## Syntax *Rust Syntax* ```text fn outgoing_message_message_type(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The message's type. This property holds the type of the message. It may be empty if the message does not have a type set. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_priority property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The priority of the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_priority(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The priority of the message. This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i32 # outgoing_message_reply_to property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The address to send replies to for the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_reply_to(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The address to send replies to for the message. This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # outgoing_message_timestamp property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's timestamp. ## Syntax *Rust Syntax* ```text fn outgoing_message_timestamp(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The message's timestamp. This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i64 # outgoing_message_user_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The identity of the user responsible for producing the message. ## Syntax *Rust Syntax* ```text fn outgoing_message_user_id(&self , OutgoingMessageIndex : i32) -> Result ``` ## Default Value "" ## Remarks The identity of the user responsible for producing the message. This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message. A message's user Id *may* be used for verification or authentication by the server and/or the final consumer. This value must be specified as a string no longer than 255 characters. The *OutgoingMessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutgoingMessageCount](#outgoing_message_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # password property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A password to use for SASL authentication. ## Syntax *Rust Syntax* ```text fn password(&self ) -> Result fn set_password(&self, value : &str) -> Option fn set_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property contains a password to use for SASL authentication. ## Data Type String # queue_message_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message count returned by various queue operations. ## Syntax *Rust Syntax* ```text fn queue_message_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property is populated with a message count after calling certain queue-related methods. | After calling... | This property will reflect... | | --- | --- | | [declare_queue](#declare_queue-method-amqpclassic-struct) | The number of messages currently in the queue. | | [purge_queue](#purge_queue-method-amqpclassic-struct) | The number of messages purged from the queue. | | [delete_queue](#delete_queue-method-amqpclassic-struct) | THe number of messages deleted along with the queue. | This property is read-only. ## Data Type i32 # received_message_app_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The Id of the application that created the message. ## Syntax *Rust Syntax* ```text fn received_message_app_id(&self ) -> Result ``` ## Default Value "" ## Remarks The Id of the application that created the message. This property holds the Id of the application that created the message. It may be empty if the message does not have an application Id set. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_body property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message body. ## Syntax *Rust Syntax* ```text fn received_message_body(&self ) -> Result, IPWorksIoTError> ``` ## Default Value "" ## Remarks The message body. This property holds the body of the message. It may be empty. This property is read-only. ## Data Type Vec # received_message_channel_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the channel the message is associated with. ## Syntax *Rust Syntax* ```text fn received_message_channel_name(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the channel the message is associated with. This property reflects the name of the channel which the message is associated with; it is populated automatically by the struct. This property is read-only. ## Data Type String # received_message_content_encoding property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content encoding of the message's body. ## Syntax *Rust Syntax* ```text fn received_message_content_encoding(&self ) -> Result ``` ## Default Value "" ## Remarks The content encoding of the message's body. This property holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_content_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The content type (MIME type) of the message's body. ## Syntax *Rust Syntax* ```text fn received_message_content_type(&self ) -> Result ``` ## Default Value "" ## Remarks The content type (MIME type) of the message's body. This property holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_correlation_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The correlation Id of the message. ## Syntax *Rust Syntax* ```text fn received_message_correlation_id(&self ) -> Result ``` ## Default Value "" ## Remarks The correlation Id of the message. This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_delivery_mode property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The delivery mode of the message. ## Syntax *Rust Syntax* ```text fn received_message_delivery_mode(&self ) -> Result ``` ## Default Value 0 ## Remarks The delivery mode of the message. This property holds the delivery mode of the message; possible values are: - *0*: Unspecified. - *1*: Non-persistent; the message may be lost if the server encounters an error. - *2*: Persistent; the message will not be lost, even in case of server errors. The default is 0, which indicates that the message does not have an explicit delivery mode set. This property is read-only. ## Data Type i32 # received_message_expiration property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The time-to-live value for this message. ## Syntax *Rust Syntax* ```text fn received_message_expiration(&self ) -> Result ``` ## Default Value "" ## Remarks The time-to-live value for this message. This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL. This property is read-only. ## Data Type String # received_message_headers property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Headers associated with the message. ## Syntax *Rust Syntax* ```text fn received_message_headers(&self ) -> Result ``` ## Default Value "" ## Remarks Headers associated with the message. This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set. This property must be specified as a JSON object containing name-type-value tuples; for example: ```text [ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } ] ``` All "name" values must be ASCII strings that: - Start with an ASCII letter, *$*, or *$* character. - Only contain ASCII letters, digits, underscores, *$*, and *$* characters. - Are unique among their siblings. - Are no longer than 128 characters. The following table describes all valid "type" values, and how to format the "value" field for each: | JSON Value Type | Description | Value Format | | --- | --- | --- | | boolean | Boolean | "True" or "False" | | byte | Byte | -128 to 127 | | ubyte | Unsigned byte | 0 to 255 | | short | Short | -32768 to 32767 | | ushort | Unsigned short | 0 to 65535 | | int | Integer | -2147483648 to 2147483647 | | uint | Unsigned integer | 0 to 4294967295 | | long | Long | -9223372036854775808 to 9223372036854775807 | | ulong | Unsigned long | 0 to 18446744073709551615 | | float | Float | IEEE 754 32-bit floating point number | | double | Double | IEEE 754 64-bit floating point number | | decimal | Decimal | Hex-encoded byte string | | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | string | String | String data | | array | Array | JSON array of type-value pairs | | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | table | Table | JSON object containing name-type-value tuples | | null | Null | N/A ([received_message_value](#AMQPClassic_p_ReceivedMessageValue) is ignored) | NOTE: The *ulong* and *sstring* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. Headers of the *table* type should be specified in the same manner as shown above, while headers of the *array* type should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` Nesting and mixing multiple levels of arrays and tables is allowed. This property is read-only. ## Data Type String # received_message_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The unique Id of the message. ## Syntax *Rust Syntax* ```text fn received_message_id(&self ) -> Result ``` ## Default Value "" ## Remarks The unique Id of the message. This property holds the unique Id of the message. It may be empty if the message does not have a unique Id. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_message_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's type. ## Syntax *Rust Syntax* ```text fn received_message_message_type(&self ) -> Result ``` ## Default Value "" ## Remarks The message's type. This property holds the type of the message. It may be empty if the message does not have a type set. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_priority property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The priority of the message. ## Syntax *Rust Syntax* ```text fn received_message_priority(&self ) -> Result ``` ## Default Value 0 ## Remarks The priority of the message. This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent. This property is read-only. ## Data Type i32 # received_message_reply_to property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The address to send replies to for the message. ## Syntax *Rust Syntax* ```text fn received_message_reply_to(&self ) -> Result ``` ## Default Value "" ## Remarks The address to send replies to for the message. This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # received_message_timestamp property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The message's timestamp. ## Syntax *Rust Syntax* ```text fn received_message_timestamp(&self ) -> Result ``` ## Default Value 0 ## Remarks The message's timestamp. This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set. This property is read-only. ## Data Type i64 # received_message_user_id property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The identity of the user responsible for producing the message. ## Syntax *Rust Syntax* ```text fn received_message_user_id(&self ) -> Result ``` ## Default Value "" ## Remarks The identity of the user responsible for producing the message. This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message. A message's user Id *may* be used for verification or authentication by the server and/or the final consumer. This value must be specified as a string no longer than 255 characters. This property is read-only. ## Data Type String # remote_host property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This property includes the address of the remote host. Domain names are resolved to IP addresses. ## Syntax *Rust Syntax* ```text fn remote_host(&self ) -> Result fn set_remote_host(&self, value : &str) -> Option fn set_remote_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established. If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned. If the struct is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. **Example. Connecting:** ```text TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true ``` ## Data Type String # remote_port property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The port of the AMQP server (default is 5672). The default port for SSL is 5671. ## Syntax *Rust Syntax* ```text fn remote_port(&self ) -> Result fn set_remote_port(&self, value : i32) -> Option ``` ## Default Value 5672 ## Remarks This property specifies a service port on the remote host to connect to. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. ## Data Type i32 # server_property_count property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The number of records in the ServerProperty arrays. ## Syntax *Rust Syntax* ```text fn server_property_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [server_property_name](#server_property_name-property-amqpclassic-struct) - [server_property_value](#server_property_value-property-amqpclassic-struct) - [server_property_value_type](#server_property_value_type-property-amqpclassic-struct) The array indices start at *0* and end at *server_property_count - 1*. This property is read-only. ## Data Type i32 # server_property_name property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's name. ## Syntax *Rust Syntax* ```text fn server_property_name(&self , ServerPropertyIndex : i32) -> Result ``` ## Default Value "" ## Remarks The table field's name. This property specifies the table field's name. The name must be an ASCII string that: - Starts with an ASCII letter, *$*, or *$* character. - Only contains ASCII letters, digits, underscores, *$*, and *$* characters. - Is unique among all sibling table field [server_property_name](#server_property_name-property-amqpclassic-struct)s. - Is no longer than 128 characters. The *ServerPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ServerPropertyCount](#server_property_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # server_property_value property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's value. ## Syntax *Rust Syntax* ```text fn server_property_value(&self , ServerPropertyIndex : i32) -> Result ``` ## Default Value "" ## Remarks The table field's value. This property specifies the table field's value. The *ServerPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ServerPropertyCount](#server_property_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type String # server_property_value_type property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The table property's value type. ## Syntax *Rust Syntax* ```text fn server_property_value_type(&self , ServerPropertyIndex : i32) -> Result ``` ## Possible Values ```text 0 // Boolean1 // Byte2 // Ubyte3 // Short4 // Ushort5 // Int6 // Uint7 // Long8 // Ulong9 // Float10 // Double11 // Decimal12 // Sstring13 // String14 // Array15 // Timestamp16 // Table17 // Null ``` ## Default Value 17 ## Remarks The table field's value type. This property specifies the table field's value type (and thus, the format of the data in the [server_property_value](#server_property_value-property-amqpclassic-struct) property). Acceptable value types are: | Value Type | JSON Value Type | Description | Value Format | | --- | --- | --- | --- | | fvtBoolean (0) | boolean | Boolean | "True" or "False" | | fvtByte (1) | byte | Byte | -128 to 127 | | fvtUbyte (2) | ubyte | Unsigned byte | 0 to 255 | | fvtShort (3) | short | Short | -32768 to 32767 | | fvtUshort (4) | ushort | Unsigned short | 0 to 65535 | | fvtInt (5) | int | Integer | -2147483648 to 2147483647 | | fvtUint (6) | uint | Unsigned integer | 0 to 4294967295 | | fvtLong (7) | long | Long | -9223372036854775808 to 9223372036854775807 | | fvtUlong (8) | ulong | Unsigned long | 0 to 18446744073709551615 | | fvtFloat (9) | float | Float | IEEE 754 32-bit floating point number | | fvtDouble (10) | double | Double | IEEE 754 64-bit floating point number | | fvtDecimal (11) | decimal | Decimal | Hex-encoded byte string | | fvtSstring (12) | sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) | | fvtString (13) | string | String | String data | | fvtArray (14) | array | Array | JSON array of type-value pairs | | fvtTimestamp (15) | timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) | | fvtTable (16) | table | Table | JSON object containing name-type-value tuples | | fvtNull (17 - default) | null | Null | N/A ([server_property_value](#server_property_value-property-amqpclassic-struct) is ignored) | NOTE: The *fvtUlong (8)* and *fvtSstring (12)* value types are not supported when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled. For the *fvtArray (14)* value type, the [server_property_value](#server_property_value-property-amqpclassic-struct) should be specified as a JSON array of type-value pairs; for example: ```text [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ] ``` For the *fvtTable (16)* value type, the [server_property_value](#server_property_value-property-amqpclassic-struct) should be specified as a JSON object containing name-type-value tuples; for example: ```text { { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } } ``` Notes regarding *fvtArray (14)* and *fvtTable (16)* type [server_property_value](#server_property_value-property-amqpclassic-struct)s: - All "type" fields in the JSON content must be set to one of the value types in the table above. - For *fvtTable (16)* type [server_property_value](#server_property_value-property-amqpclassic-struct)s, all "name" fields must adhere to the rules described by the [server_property_key](#AMQPClassic_p_ServerPropertyKey) documentation. - Nesting and mixing multiple levels of arrays and tables in the JSON is allowed. The *ServerPropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ServerPropertyCount](#server_property_count-property-amqpclassic-struct) property. This property is read-only. ## Data Type i32 # ssl_accept_server_cert_effective_date property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_effective_date(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_expiration_date(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_issuer(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key(&self ) -> Result ``` ## 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](#ssl_accept_server_cert_private_key-property-amqpclassic-struct) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-amqpclassic-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_accept_server_cert_private_key_available property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-amqpclassic-struct) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key_length(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_serial_number(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store(&self ) -> Result, IPWorksIoTError> fn set_ssl_accept_server_cert_store(&self, value : Vec) -> Option fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-amqpclassic-struct) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-amqpclassic-struct). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-amqpclassic-struct) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) 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 *Rust Syntax* ```text fn ssl_accept_server_cert_store_password(&self ) -> Result fn set_ssl_accept_server_cert_store_password(&self, value : &str) -> Option fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store_type(&self ) -> Result fn set_ssl_accept_server_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-amqpclassic-struct), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-amqpclassic-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-amqpclassic-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssl_accept_server_cert_subject_alt_names property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-amqpclassic-struct). 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-amqpclassic-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-amqpclassic-struct) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-amqpclassic-struct). 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_version(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_subject(&self ) -> Result fn set_ssl_accept_server_cert_subject(&self, value : &str) -> Option fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) -> Option ``` ## 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # ssl_accept_server_cert_encoded property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_encoded(&self ) -> Result, IPWorksIoTError> fn set_ssl_accept_server_cert_encoded(&self, value : Vec) -> Option fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-amqpclassic-struct) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-amqpclassic-struct) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-amqpclassic-struct) is set to an empty string. ## Data Type Vec # ssl_cert_effective_date property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_cert_effective_date(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_cert_expiration_date(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_issuer(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key(&self ) -> Result ``` ## 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](#ssl_cert_private_key-property-amqpclassic-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-amqpclassic-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_cert_private_key_available property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-amqpclassic-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_algorithm(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_length(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_cert_serial_number(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_signature_algorithm(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store(&self ) -> Result, IPWorksIoTError> fn set_ssl_cert_store(&self, value : Vec) -> Option fn set_ssl_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property-amqpclassic-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-amqpclassic-struct). [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-amqpclassic-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) 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 *Rust Syntax* ```text fn ssl_cert_store_password(&self ) -> Result fn set_ssl_cert_store_password(&self, value : &str) -> Option fn set_ssl_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store_type(&self ) -> Result fn set_ssl_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property-amqpclassic-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-amqpclassic-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-amqpclassic-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssl_cert_subject_alt_names property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-amqpclassic-struct). 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-amqpclassic-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_cert_usage](#ssl_cert_usage-property-amqpclassic-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-amqpclassic-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_cert_version property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_cert_version(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject(&self ) -> Result fn set_ssl_cert_subject(&self, value : &str) -> Option fn set_ssl_cert_subject_ref(&self, value : &String) -> Option ``` ## 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # ssl_cert_encoded property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_cert_encoded(&self ) -> Result, IPWorksIoTError> fn set_ssl_cert_encoded(&self, value : Vec) -> Option fn set_ssl_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct) and [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property-amqpclassic-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-amqpclassic-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-amqpclassic-struct) is set to an empty string. ## Data Type Vec # ssl_enabled property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. ## Syntax *Rust Syntax* ```text fn ssl_enabled(&self ) -> Result fn set_ssl_enabled(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled. TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value. If the default port (5672) is selected when SSLEnabled is set to true, the port will automatically be changed to the default port for AMQP with SSL (5671). Likewise, if port 5671 is selected when SSLEnabled is set to false, the port will automatically be changed to the default port. If the port has been set to any value other than the default values, it will remain the same when the value of SSLEnabled changes. ## Data Type bool # ssl_provider property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Rust Syntax* ```text fn ssl_provider(&self ) -> Result fn set_ssl_provider(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // 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: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** 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](#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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_effective_date(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_expiration_date(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_issuer(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key(&self ) -> Result ``` ## 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](#ssl_server_cert_private_key-property-amqpclassic-struct) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-amqpclassic-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_server_cert_private_key_available property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-amqpclassic-struct) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-amqpclassic-struct) 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key_algorithm(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key_length(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_serial_number(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_signature_algorithm(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store(&self ) -> Result, IPWorksIoTError> ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-amqpclassic-struct) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-amqpclassic-struct). [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-amqpclassic-struct) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) 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 *Rust Syntax* ```text fn ssl_server_cert_store_password(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store_type(&self ) -> Result ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-amqpclassic-struct), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-amqpclassic-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-amqpclassic-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type i32 # ssl_server_cert_subject_alt_names property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_server_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-amqpclassic-struct). 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-amqpclassic-struct) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_server_cert_usage](#ssl_server_cert_usage-property-amqpclassic-struct) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-amqpclassic-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_server_cert_version property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_version(&self ) -> Result ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_subject(&self ) -> Result ``` ## 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: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. ## Data Type String # ssl_server_cert_encoded property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_encoded(&self ) -> Result, IPWorksIoTError> ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct) and [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-amqpclassic-struct) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property-amqpclassic-struct) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property-amqpclassic-struct) is set to an empty string. This property is read-only. ## Data Type Vec # timeout property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This property includes the timeout for the struct. ## Syntax *Rust Syntax* ```text fn timeout(&self ) -> Result fn set_timeout(&self, value : i32) -> Option ``` ## Default Value 60 ## Remarks If the timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If timeout is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of timeout seconds. The struct will use [do_events](#do_events-method-amqpclassic-struct) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If timeout expires, and the operation is not yet complete, the struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received. The default value for the timeout property is 60 seconds. ## Data Type i32 # user property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) A username to use for SASL authentication. ## Syntax *Rust Syntax* ```text fn user(&self ) -> Result fn set_user(&self, value : &str) -> Option fn set_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property contains a username to use for SASL authentication. ## Data Type String # virtual_host property ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The virtual host to connect to. ## Syntax *Rust Syntax* ```text fn virtual_host(&self ) -> Result fn set_virtual_host(&self, value : &str) -> Option fn set_virtual_host_ref(&self, value : &String) -> Option ``` ## Default Value "/" ## Remarks This property specifies the virtual host to connect to on the server, and is set to */* by default. Note that the configuration of the server defines what virtual hosts are available. This setting cannot be changed while connected. ## Data Type String # bind_queue method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Binds a queue to an exchange. ## Syntax *Rust Syntax* ```text fn bind_queue(&self, channel_name : &str, queue_name : &str, exchange_name : &str, routing_key : &str, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to bind the queue named *QueueName* to the exchange named *ExchangeName*. Exchanges use bindings to determine which queues to route messages to. Multiple bindings between the same queue and exchange with different *RoutingKey*s and/or arguments are allowed; requests that would create a duplicate binding are ignored. No queue will ever receive duplicate copies of any message, regardless of what bindings are present on the server. Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a *direct* exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call [publish_message](#publish_message-method-amqpclassic-struct), pass empty string for *ExchangeName*, and the name of the desired queue for *RoutingKey*. *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. *QueueName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. The server's default exchange may be specified by passing empty string for *ExchangeName*. Otherwise, *ExchangeName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. The *RoutingKey* parameter specifies the binding's routing key. Exchanges that use routing-key-based logic make some sort of comparison between the routing keys of incoming messages and this value to decide which messages should be forwarded to the specified queue. Examples of exchange types which use routing keys include: - *direct* exchanges, which compare (for equality) the routing keys of incoming messages to the routing keys of each queue bound to them. - *topic* exchanges, which match the routing keys of incoming messages against the routing pattern of each queue bound to them. Not all exchange types make use of routing keys, in which case empty string can be passed for the *RoutingKey* parameter. Examples of exchange types which don't use routing keys include: - *fanout* exchanges simply forward incoming messages to all queues bound to them, unconditionally. - *header* exchanges only forward messages that include certain headers. When binding a queue to a *header* exchange, add items to the arguments collection to describe the headers that eligible messages must have, and whether they must have *any* or *all* of those headers. Note that the format of the *RoutingKey* parameter and/or the content of the arguments collection may differ slightly between server implementations. Refer to your server's documentation to determine what it expects to receive for each exchange type that it supports. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - No queue with the given *QueueName* exists. - No exchange with the given *ExchangeName* exists. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. **Binding a Queue to an Exchange** ```csharp // Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey". amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false); ``` # cancel_consume method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Cancels an existing consumer. ## Syntax *Rust Syntax* ```text fn cancel_consume(&self, channel_name : &str, consumer_tag : &str, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method requests that the server cancel the consumer identified by the given *ConsumerTag* on the channel specified by *ChannelName*. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because no consumer with the given *ConsumerTag* exists. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # close_channel method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Closes a channel. ## Syntax *Rust Syntax* ```text fn close_channel(&self, channel_name : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method closes the channel named *ChannelName* and removes it from the channels properties. If no channel with the given *ChannelName* exists, an exception will be thrown. # commit_transaction method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Commits the current transaction for a channel. ## Syntax *Rust Syntax* ```text fn commit_transaction(&self, channel_name : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method commits the current transaction for the channel with the given *ChannelName*. A new transaction is started immediately after the current one is committed. Refer to [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) for more information about transactions. An exception is thrown if a channel with the given *ChannelName* doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # config method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-amqpclassic-struct) 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](#config-settings-amqpclassic-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This method connects to a remote host. ## Syntax *Rust Syntax* ```text fn connect(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method connects to the remote host specified by [remote_host](#remote_host-property-amqpclassic-struct) and [remote_port](#remote_port-property-amqpclassic-struct). For instance: ```text component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect(); ``` # connect_to method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This method connects to a remote host. ## Syntax *Rust Syntax* ```text fn connect_to(&self, host : &str, port : i32) -> Result<(), IPWorksIoTError> ``` ## Remarks This method connects to the remote host specified by the *host* and *port* parameters. For instance: ```text component.ConnectTo("MyHostNameOrIP", 777) ``` # consume method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Starts a new consumer for a given queue. ## Syntax *Rust Syntax* ```text fn consume(&self, channel_name : &str, queue_name : &str, consumer_tag : &str, no_local : bool, no_ack : bool, exclusive : bool, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method instructs the server to start a new consumer on the queue named *QueueName*; once the consumer is created, it will cause messages enqueued to the specified queue to be delivered to the struct over the channel specified by *ChannelName*. Consumers last as long as the channel they were created on, or until they are cancelled using the [cancel_consume](#cancel_consume-method-amqpclassic-struct) method. Each time a message is delivered to the struct, it is immediately added to the incoming_messages collection, the received_message property is populated, and the [on_message_in](#on_message_in-event-amqpclassic-struct) event fires. *ConsumerTag* is a string which uniquely identifies the new consumer on the specified channel. If empty string is passed for *ConsumerTag*, the server will generate a consumer tag automatically when it creates the . this auto-generated consumer tag can then be retrieved by querying the [ConsumerTag](#ConsumerTag) configuration setting after this method returns. The *NoLocal* parameter, if *True*, ensures that the consumer never consumes messages published on the same channel. (Note that this functionality is not available on RabbitMQ servers, which ignore the *NoLocal* parameter). The *NoAck* parameter controls whether the server will expect the struct to acknowledge the each message delivered. Refer to [on_message_in](#on_message_in-event-amqpclassic-struct) for more information about acknowledging messages. The *Exclusive* parameter, if *True*, will cause the struct to request that the server create an exclusive consumer. Attaching an exclusive consumer to a queue prevents any other consumers from consuming messages from that queue. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. Additional arguments may be sent with this request by adding them to the arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - No queue with the given *QueueName* exists. - The given *ConsumerTag* is already in use on the specified channel. - An exclusive consumer was requested for a queue which already has consumers attached to it. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. **Receiving a Message** ```csharp // MessageIn event handler. amqpc1.OnMessageIn += (s, e) => { if (e.MessageCount == -1) { // The server pushed a message to us asynchronously due to a consumer we created. Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':"); Console.WriteLine(amqpc1.ReceivedMessage.Body); } else if (e.DeliveryTag > 0) { // We pulled a message from a queue with the RetrieveMessage() method. Console.WriteLine("Message successfully pulled:"); Console.WriteLine(amqpc1.ReceivedMessage.Body); Console.WriteLine(e.MessageCount + " messages are still available to pull."); } else { // We tried to pull a message, but there were none available to pull. Console.WriteLine("No messages available to pull."); } }; // Attach a consumer to "MyQueue". amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false); // Or, try to retrieve a message from "MyQueue". amqpc1.RetrieveMessage("channel", "MyQueue", true); ``` # create_channel method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Creates a new channel. ## Syntax *Rust Syntax* ```text fn create_channel(&self, channel_name : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method creates a new channel with the name *ChannelName* and adds it to the channels properties. If a channel with the given *ChannelName* already exists, an error will be thrown. **Connecting and Creating a Channel** ```csharp // The examples in this documentation use a RabbitMQ server, which requires SASL Plain auth. amqpc1.AuthScheme = AmqpclassicAuthSchemes.smSASLPlain; amqpc1.User = "guest"; amqpc1.Password = "guest"; amqpc1.SSLEnabled = true; amqpc1.ConnectTo("amqpclassic.test-server.com", 5671); amqpc1.CreateChannel("channel"); ``` # declare_exchange method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Verifies that an exchange exists, potentially creating it if necessary. ## Syntax *Rust Syntax* ```text fn declare_exchange(&self, channel_name : &str, exchange_name : &str, exchange_type : &str, passive : bool, durable : bool, auto_delete : bool, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to verify that an exchange named *ExchangeName* exists; and potentially creates it if no such exchange exists. *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. *ExchangeName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with *amq.* unless the *Passive* parameter is *True*. *ExchangeType* specifies the exchange type. All servers support the *direct* and *fanout* exchange types, and most should also support the *topic* and *header* exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than *direct* and *fanout*. If *Passive* is *True*, the server will only verify that an exchange with the given *ExchangeName* actually exists (regardless of how it is configured). If *Passive* is *False*, and no exchange named *ExchangeName* currently exists, the server will create one. If *Passive* is *False*, and there is a preexisting exchange named *ExchangeName*, the server will verify that its current configuration matches the given parameters and arguments. *Durable* specifies what happens to the exchange in the event of a server restart. Durable exchanges will be recreated, while non-durable (transient) exchanges will not. *AutoDelete* specifies whether the server should automatically delete the exchange when all queues have been unbound from it. Note that this parameter is only sent if the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled; it is ignored otherwise. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. Additional arguments may be sent with this request by adding them to the arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - One of the parameter constraints described above was violated. - One of the verification cases described above fails. - The value passed for *ExchangeType* did not correspond to an exchange type supported by the server. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. **Declaring an Exchange** ```csharp // Declare a direct-type exchange. amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false); ``` # declare_queue method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Verifies that a queue exists, potentially creating it if necessary. ## Syntax *Rust Syntax* ```text fn declare_queue(&self, channel_name : &str, queue_name : &str, passive : bool, durable : bool, exclusive : bool, auto_delete : bool, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to verify that a queue named *QueueName* exists; and potentially creates it if no such queue exists. After each successful call to this method, the struct populates the [queue_message_count](#queue_message_count-property-amqpclassic-struct) property, as well as the [QueueConsumerCount](#QueueConsumerCount) and [QueueName](#QueueName) configuration settings. Refer to each one for more information. *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. If creating a new queue, empty string can be passed for *QueueName* to have the server automatically generate a name for the new queue (which can then be retrieved using the [QueueName](#QueueName) configuration setting). In all other cases, *QueueName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with *amq.* unless the *Passive* parameter is *True*. If *Passive* is *True*, the server will only verify that a queue with the given *QueueName* actually exists (regardless of how it is configured). If *Passive* is *False*, and no queue named *QueueName* currently exists, the server will create one. If *Passive* is *False*, and there is a preexisting queue named *QueueName*, the server will verify that its current configuration matches the given parameters and arguments. *Durable* specifies what happens to the queue in the event of a server restart. Durable queue will be recreated, while non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent.) *Exclusive*, if *True*, indicates that the queue may only be accessed by the current connection. Exclusive queues are deleted when the current connection closes. *AutoDelete* specifies whether the server should automatically delete the queue when all consumers have finished using it. (Note that auto-delete queues aren't eligible for deletion until *after* a consumer attaches to them for the first time.) The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. Additional arguments may be sent with this request by adding them to the arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request. An exception is thrown if no channel with the given *ChannelName* exists, if *QueueName* empty string and *NoWait* is *True*, or if the server returns an error because: - One of the parameter constraints described above was violated. - One of the verification cases described above fails. - An attempt was made to verify (i.e., the *Passive* parameter was *True*) another connection's exclusive queue. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. **Declaring a Queue** ```csharp // Declare a queue. amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false); ``` # delete_exchange method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Deletes an exchange. ## Syntax *Rust Syntax* ```text fn delete_exchange(&self, channel_name : &str, exchange_name : &str, if_unused : bool, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to delete an exchange. *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. *ExchangeName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with *amq.*. When *IfUnused* is *True*, the server will only delete the exchange if no queues are bound to it. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - The value passed for *ExchangeName* fails one or more of the constraints described above. - No exchange named *ExchangeName* exists. (This does not apply for RabbitMQ; attempting to delete a non-existent exchange will always succeed.) - The *IfUnused* parameter was *True*, but the exchange still had one or more queues bound to it. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # delete_queue method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Deletes a queue. ## Syntax *Rust Syntax* ```text fn delete_queue(&self, channel_name : &str, queue_name : &str, if_unused : bool, if_empty : bool, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to delete the queue named *QueueName*. After each successful call to this method, the struct populates the [queue_message_count](#queue_message_count-property-amqpclassic-struct) property with the number of messages deleted along with the queue. (Note that this does not occur if the *NoWait* parameter is set to *True*.) *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. *QueueName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with *amq.*. When *IfUnused* is *True*, the server will only delete the queue if no consumers are attached to it. When *IfEmpty* is *True*, the server will only delete the queue if it has no messages in it. (When *IfEmpty* is *False*, servers will typically move any remaining messages to a dead-letter queue, if one is available.) The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - The value passed for *QueueName* fails one or more of the constraints described above. - No queue named *QueueName* exists. (This does not apply for RabbitMQ; attempting to delete a non-existent queue will always succeed.) - The *IfUnused* parameter was *True*, but the queue still had one or more consumers attached to it. - The *IfEmpty* parameter was *True*, but the queue still had one or more messages in it. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # disconnect method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This method disconnects from the remote host. ## Syntax *Rust Syntax* ```text fn disconnect(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method disconnects from the remote host. # do_events method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This method processes events from the internal message queue. ## Syntax *Rust Syntax* ```text fn do_events(&self) -> Result<(), IPWorksIoTError> ``` ## 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. # enable_publish_confirms method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Enables publish confirmations mode for a channel. ## Syntax *Rust Syntax* ```text fn enable_publish_confirms(&self, channel_name : &str, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method enables publish confirmations mode for the channel with the given *ChannelName*. While a channel is in publish confirmations mode, the server will acknowledge each message published by the struct. The struct will wait to fire the [on_message_out](#on_message_out-event-amqpclassic-struct) event until it receives this acknowledgment. (Note that this mode is only available when the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled.) Note that **a channel will stay in publish confirmations mode, once enabled, until it is deleted**. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. An exception is thrown if the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is currently *False*, if no channel with the given *ChannelName* exists, or if [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) has been called for the specified channel previously. # enable_transaction_mode method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Enables transaction mode for a channel. ## Syntax *Rust Syntax* ```text fn enable_transaction_mode(&self, channel_name : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method enables transaction mode for the channel with the given *ChannelName*. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back. To commit the current transaction on a channel, call [commit_transaction](#commit_transaction-method-amqpclassic-struct); and to roll it back (and discard the messages and acknowledgements that were part of it), call [rollback_transaction](#rollback_transaction-method-amqpclassic-struct). Keep in mind that, according to the AMQP 0.9.1 specification: - A new transaction is **always** started immediately after committing or rolling back the current one, which means that... - ...**a channel will stay in transaction mode, once enabled, until it is deleted**. - Transactions are only guaranteed to be atomic if all messages published *and* acknowledgements sent affect a single queue. - Any messages published on a channel in transaction mode that have the *Mandatory* or *Immediate* flags set are not guaranteed to be included in the transaction. An exception is thrown if no channel with the given *ChannelName* exists, or if [enable_publish_confirms](#enable_publish_confirms-method-amqpclassic-struct) has been called for the specified channel previously. # interrupt method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Interrupt the current action and disconnects from the remote host. ## Syntax *Rust Syntax* ```text fn interrupt(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method will interrupt the current method (if applicable) and cause the struct to disconnect from the remote host. # publish_message method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Publishes a message. ## Syntax *Rust Syntax* ```text fn publish_message(&self, channel_name : &str, exchange_name : &str, routing_key : &str, mandatory : bool, immediate : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to publish the message specified by the message property to the exchange named *ExchangeName* over the channel specified by *ChannelName*. When this method is called, the message to publish is immediately added to the outgoing_messages collection, and the [on_message_out](#on_message_out-event-amqpclassic-struct) event fires once it has been sent (or, if the specified channel is in "publish confirmations" mode, after the server has acknowledged it). Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a *direct* exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call publish_message, pass empty string for *ExchangeName*, and the name of the desired queue for *RoutingKey*. Note that messages published over channels which are in either transaction or "publish confirmations" mode may be handled differently than they would be on a channel in normal mode. Refer to the [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) and [enable_publish_confirms](#enable_publish_confirms-method-amqpclassic-struct) methods for more information about what each mode entails. The server's default exchange may be specified by passing empty string for *ExchangeName*. Otherwise, *ExchangeName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. The *RoutingKey* parameter specifies the message's routing key. Whether this parameter needs to be non-empty, and what format it should have if so, depends on the type of exchange it is being sent to. Some exchange types may use information included with the message, such as its [message_headers](#message_headers-property-amqpclassic-struct). Refer to [bind_queue](#bind_queue-method-amqpclassic-struct) for more information about how routing keys are used, and to your server's documentation for information on what it expects. The *Mandatory* parameter controls what the server should do if the message can't be routed to any queue (either because it isn't eligible for any of the queues bound to the specified exchange because of how their bindings are configured, or because no queues are bound to the exchange in the first place). If *True*, the server will return the message, at which point the [on_message_returned](#on_message_returned-event-amqpclassic-struct) event will be fired. If *False*, the server will drop the message. The *Immediate* parameter controls what the server should do if the message can't be immediately delivered to any consumer (either because it cannot be routed to a queue, or because the queues it can be routed to have no active consumers attached to them). If *True*, the server will return the message, at which point the [on_message_returned](#on_message_returned-event-amqpclassic-struct) event will be fired. If *False*, the server will queue the message if possible, or drop it if not. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - The value passed for *ExchangeName* fails one or more of the constraints described above. - No exchange named *ExchangeName* exists. - The message is rejected for some reason. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. **Publishing a Message** ```csharp amqpc1.Message.Body = "Hello, world!"; // Publish a message to the server's default (no-name) exchange, using the name of a specific queue as the routing key. amqpc1.PublishMessage("channel", "", "MyQueue", false, false); // Publish a message to the "MyExchange" exchange, using the routing key "MyRoutingKey". amqpc1.PublishMessage("channel", "MyExchange", "MyRoutingKey", false, false); ``` # purge_queue method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Purges all messages from a queue. ## Syntax *Rust Syntax* ```text fn purge_queue(&self, channel_name : &str, queue_name : &str, no_wait : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method purges all messages from the queue named *QueueName*. Messages which have been sent but are awaiting acknowledgment are not affected. After each successful call to this method, the struct populates the [queue_message_count](#queue_message_count-property-amqpclassic-struct) property with the number of messages purged from the queue. (Note that this does not occur if the *NoWait* parameter is set to *True*.) *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. *QueueName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. The *NoWait* parameter, if *True*, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because no queue named *QueueName* exists. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # recover method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Request that the server redeliver all messages on a given channel that have not been acknowledged. ## Syntax *Rust Syntax* ```text fn recover(&self, channel_name : &str, requeue : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to request that the server redeliver all messages that it previously sent to the struct on the channel specified by *ChannelName* which are still awaiting acknowledgment. A call to this method may cause the server to redeliver zero or more messages over the channel specified by *ChannelName*. Those messages will cause the [on_message_in](#on_message_in-event-amqpclassic-struct) event to fire with its *Redelivered* event parameter set to *True*. The *Requeue* parameter controls how the server should attempt to redeliver the messages awaiting acknowledgment. If set to *True*, the server will simple put the messages back on their original queues, and they will be delivered like any other queued messages (potentially to other consumers). If set to *False*, the server will redeliver the messages to the struct directly. An exception is thrown if no channel with the given *ChannelName* exists, or (for RabbitMQ only) if the server returns an error because *Requeue* was *False*. (RabbitMQ only supports setting *Requeue* to *True*.) Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # reset method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) This method will reset the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method will reset the struct's properties to their default values. # reset_message method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Resets the Message properties. ## Syntax *Rust Syntax* ```text fn reset_message(&self) -> Result<(), IPWorksIoTError> ``` ## Remarks This method resets the message property. # retrieve_message method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Attempts to retrieve a message from a given queue. ## Syntax *Rust Syntax* ```text fn retrieve_message(&self, channel_name : &str, queue_name : &str, no_ack : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method attempts to retrieve a message from the queue named *QueueName* over the channel named *ChannelName*. If a message is retrieved as a result of this method being called, it is immediately added to the incoming_messages collection, the received_message property is populated, and the [on_message_in](#on_message_in-event-amqpclassic-struct) event fires. Even if no message gets retrieved, the [on_message_in](#on_message_in-event-amqpclassic-struct) event will still fire as long as the request was successful. The server returns the number of available messages in the specified queue in response to *all* successful retrieve requests, and that count is exposed by [on_message_in](#on_message_in-event-amqpclassic-struct) event's *MessageCount* parameter. Refer to the [on_message_in](#on_message_in-event-amqpclassic-struct) event for more information. *QueueName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. The *NoAck* parameter controls whether the server will expect the struct to acknowledge the retrieved message. Refer to [on_message_in](#on_message_in-event-amqpclassic-struct) for more information about acknowledging messages. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - No queue with the given *QueueName* exists. - The specified queue exists, but is locked or otherwise unavailable to consume from (e.g., an exclusive consumer might be attached to it). Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. **Receiving a Message** ```csharp // MessageIn event handler. amqpc1.OnMessageIn += (s, e) => { if (e.MessageCount == -1) { // The server pushed a message to us asynchronously due to a consumer we created. Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':"); Console.WriteLine(amqpc1.ReceivedMessage.Body); } else if (e.DeliveryTag > 0) { // We pulled a message from a queue with the RetrieveMessage() method. Console.WriteLine("Message successfully pulled:"); Console.WriteLine(amqpc1.ReceivedMessage.Body); Console.WriteLine(e.MessageCount + " messages are still available to pull."); } else { // We tried to pull a message, but there were none available to pull. Console.WriteLine("No messages available to pull."); } }; // Attach a consumer to "MyQueue". amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false); // Or, try to retrieve a message from "MyQueue". amqpc1.RetrieveMessage("channel", "MyQueue", true); ``` # rollback_transaction method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Rolls back the current transaction for a channel. ## Syntax *Rust Syntax* ```text fn rollback_transaction(&self, channel_name : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method rolls back the current transaction for the channel with the given *ChannelName*. A new transaction is started immediately after the current one is rolled back. Refer to [enable_transaction_mode](#enable_transaction_mode-method-amqpclassic-struct) for more information about transactions. An exception is thrown if a channel with the given *ChannelName* doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # set_channel_accept method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Disables or enables message acceptance for a given channel. ## Syntax *Rust Syntax* ```text fn set_channel_accept(&self, channel_name : &str, accept : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to disable and enable message acceptance for the channel specified by *ChannelName*. A channel is always configured to accept messages when first created, allowing the server to freely deliver messages to the struct for any consumers that have been created on that channel using the [consume](#consume-method-amqpclassic-struct) method. Disabling message acceptance for a channel prevents the server from automatically delivering messages to the struct over it; however, it is still possible to use the [retrieve_message](#retrieve_message-method-amqpclassic-struct) method to synchronously attempt to retrieve a message on a channel with message acceptance disabled. An exception is thrown if no channel with the given *ChannelName* exists, or (for RabbitMQ only) if the server returns an error because *Accept* was *False*. (RabbitMQ does not support disabling message acceptance.) Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # set_qo_s method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Requests a specific quality of service (QoS). ## Syntax *Rust Syntax* ```text fn set_qo_s(&self, channel_name : &str, prefetch_size : i32, prefetch_count : i32, global : bool) -> Result<(), IPWorksIoTError> ``` ## Remarks This method is used to request a specific quality of service for a certain scope. When the *PrefetchSize* and/or *PrefetchCount* are set for a certain scope, the server will limit how many messages it sends to the struct before stopping to wait for one or more of them to be acknowledged. *ChannelName* is the name of the channel which is used to send the request. Depending on the server and what *Global* is set to, it may also be significant to the request itself (refer to the *Global* parameter's description, below, for more information). *PrefetchSize* specifies a window size in bytes; i.e., the server will stop sending messages if the total size of all of the currently unacknowledged messages already sent, plus the size of the next message that could be sent, exceeds *PrefetchSize* bytes. A *PrefetchSize* of *0* indicates no limit. (Note that RabbitMQ does not support prefetch size limits.) *PrefetchCount* specifies the number of unacknowledged messages the server will limit itself to sending. A *PrefetchCount* of *0* indicates no limit. *Global* specifies the scope which the QoS request should apply to. It is interpreted differently based on whether the server is RabbitMQ or not. Refer to this table: | Global is... | RabbitMQ | Other Servers | | --- | --- | --- | | False | QoS will be applied individually to each new consumer on the specified channel (existing consumers are unaffected). | QoS applied to all existing and new consumers on the specified channel. | | True | QoS applied to all existing and new consumers on the specified channel. | QoS applied to all existing and new consumers on the whole connection. | Keep the following things in mind when using QoS: - The limits specified by a QoS request only affect messages that require acknowledgment. - How the server chooses to handle interactions between QoS settings at different scopes is server-dependent. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error for any reason. Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # unbind_queue method ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Removes a previously-created queue binding. ## Syntax *Rust Syntax* ```text fn unbind_queue(&self, channel_name : &str, queue_name : &str, exchange_name : &str, routing_key : &str) -> Result<(), IPWorksIoTError> ``` ## Remarks This method removes a previously-created queue binding. *ChannelName* controls what channel the struct will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that *is not* involved in message publishing or consumption. *QueueName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. The server's default exchange may be specified by passing empty string for *ExchangeName*. Otherwise, *ExchangeName* must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters. *RoutingKey* should be the same routing key used when originally creating the binding that is to be removed. For bindings created using arguments instead of a routing key, the arguments collection must contain the same items used originally instead. An exception is thrown if no channel with the given *ChannelName* exists, or if the server returns an error because: - No queue with the given *QueueName* exists. (Does not apply to RabbitMQ.) - No exchange with the given *ExchangeName* exists. (Does not apply to RabbitMQ.) Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes AMQP's various connection and channel errors. # on_channel_ready_to_send event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fires when a channel is ready to send messages. ## Syntax *Rust Syntax* ```text // AMQPClassicChannelReadyToSendEventArgs carries the AMQPClassic ChannelReadyToSend event's parameters. pub struct AMQPClassicChannelReadyToSendEventArgs { fn channel_name(&self) -> &String } // AMQPClassicChannelReadyToSendEvent defines the signature of the AMQPClassic ChannelReadyToSend event's handler function. pub trait AMQPClassicChannelReadyToSendEvent { fn on_channel_ready_to_send(&self, sender : AMQPClassic, e : &mut AMQPClassicChannelReadyToSendEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_channel_ready_to_send(&self) -> &'a dyn AMQPClassicChannelReadyToSendEvent; pub fn set_on_channel_ready_to_send(&mut self, value : &'a dyn AMQPClassicChannelReadyToSendEvent); ... } ``` ## Remarks This event fires when a channel is ready to send messages. *ChannelName* is the name of the channel. # on_connected event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fired immediately after a connection completes (or fails). ## Syntax *Rust Syntax* ```text // AMQPClassicConnectedEventArgs carries the AMQPClassic Connected event's parameters. pub struct AMQPClassicConnectedEventArgs { fn status_code(&self) -> i32 fn description(&self) -> &String } // AMQPClassicConnectedEvent defines the signature of the AMQPClassic Connected event's handler function. pub trait AMQPClassicConnectedEvent { fn on_connected(&self, sender : AMQPClassic, e : &mut AMQPClassicConnectedEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_connected(&self) -> &'a dyn AMQPClassicConnectedEvent; pub fn set_on_connected(&mut self, value : &'a dyn AMQPClassicConnectedEvent); ... } ``` ## 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](#trappable-errors-amqpclassic-struct) section for more information. # on_connection_status event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fired to indicate changes in the connection state. ## Syntax *Rust Syntax* ```text // AMQPClassicConnectionStatusEventArgs carries the AMQPClassic ConnectionStatus event's parameters. pub struct AMQPClassicConnectionStatusEventArgs { fn connection_event(&self) -> &String fn status_code(&self) -> i32 fn description(&self) -> &String } // AMQPClassicConnectionStatusEvent defines the signature of the AMQPClassic ConnectionStatus event's handler function. pub trait AMQPClassicConnectionStatusEvent { fn on_connection_status(&self, sender : AMQPClassic, e : &mut AMQPClassicConnectionStatusEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_connection_status(&self) -> &'a dyn AMQPClassicConnectionStatusEvent; pub fn set_on_connection_status(&mut self, value : &'a dyn AMQPClassicConnectionStatusEvent); ... } ``` ## Remarks This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake. The *connection_event* parameter indicates the type of connection event. Values may include the following: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *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. # on_disconnected event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fired when a connection is closed. ## Syntax *Rust Syntax* ```text // AMQPClassicDisconnectedEventArgs carries the AMQPClassic Disconnected event's parameters. pub struct AMQPClassicDisconnectedEventArgs { fn status_code(&self) -> i32 fn description(&self) -> &String } // AMQPClassicDisconnectedEvent defines the signature of the AMQPClassic Disconnected event's handler function. pub trait AMQPClassicDisconnectedEvent { fn on_disconnected(&self, sender : AMQPClassic, e : &mut AMQPClassicDisconnectedEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_disconnected(&self) -> &'a dyn AMQPClassicDisconnectedEvent; pub fn set_on_disconnected(&mut self, value : &'a dyn AMQPClassicDisconnectedEvent); ... } ``` ## 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](#trappable-errors-amqpclassic-struct) section for more information. # on_error event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fired when information is available about errors during data delivery. ## Syntax *Rust Syntax* ```text // AMQPClassicErrorEventArgs carries the AMQPClassic Error event's parameters. pub struct AMQPClassicErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // AMQPClassicErrorEvent defines the signature of the AMQPClassic Error event's handler function. pub trait AMQPClassicErrorEvent { fn on_error(&self, sender : AMQPClassic, e : &mut AMQPClassicErrorEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_error(&self) -> &'a dyn AMQPClassicErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn AMQPClassicErrorEvent); ... } ``` ## 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](#trappable-errors-amqpclassic-struct) section. # on_log event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fires once for each log message. ## Syntax *Rust Syntax* ```text // AMQPClassicLogEventArgs carries the AMQPClassic Log event's parameters. pub struct AMQPClassicLogEventArgs { fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // AMQPClassicLogEvent defines the signature of the AMQPClassic Log event's handler function. pub trait AMQPClassicLogEvent { fn on_log(&self, sender : AMQPClassic, e : &mut AMQPClassicLogEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_log(&self) -> &'a dyn AMQPClassicLogEvent; pub fn set_on_log(&mut self, value : &'a dyn AMQPClassicLogEvent); ... } ``` ## Remarks This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of the *Message*. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | *LogType* identifies the type of log entry. Possible values are: - Info: General information about the struct. - Frame: Frame status messages. # on_message_in event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue. ## Syntax *Rust Syntax* ```text // AMQPClassicMessageInEventArgs carries the AMQPClassic MessageIn event's parameters. pub struct AMQPClassicMessageInEventArgs { fn channel_name(&self) -> &String fn consumer_tag(&self) -> &String fn delivery_tag(&self) -> i64 fn redelivered(&self) -> bool fn exchange_name(&self) -> &String fn routing_key(&self) -> &String fn message_count(&self) -> i32 fn accept(&self) -> i32 fn set_accept(&self, value : i32) } // AMQPClassicMessageInEvent defines the signature of the AMQPClassic MessageIn event's handler function. pub trait AMQPClassicMessageInEvent { fn on_message_in(&self, sender : AMQPClassic, e : &mut AMQPClassicMessageInEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_message_in(&self) -> &'a dyn AMQPClassicMessageInEvent; pub fn set_on_message_in(&mut self, value : &'a dyn AMQPClassicMessageInEvent); ... } ``` ## Remarks This event fires anytime a message is received. There are two possible ways for the struct to receive a message: - Messages can be asynchronously *pushed* to the struct from the server. At any point in time, the server may push a message to the struct from a queue that the [consume](#consume-method-amqpclassic-struct) method has been used to attach a consumer to. - Messages can be synchronously *pulled* from the server by the struct. The [retrieve_message](#retrieve_message-method-amqpclassic-struct) method is used to attempt to pull (or "retrieve") messages from a specific queue. This event *also* fires anytime [retrieve_message](#retrieve_message-method-amqpclassic-struct) is called against a queue that currently has no messages available to pull. This is a special case, and results in only the *ChannelName* and *MessageCount* event parameters being populated. Other than that special case, and any exceptions noted below, this event's parameters are populated the same way regardless of the manner in which messages are received. *ChannelName* always reflects the name of the associated channel. *ConsumerTag* reflects the consumer tag associated with the consumer that caused the server to push the message to the struct. (*ConsumerTag* is always empty for messages pulled from the server by [retrieve_message](#retrieve_message-method-amqpclassic-struct) since no consumers are involved.) *DeliveryTag* reflects the server-assigned, channel-specific delivery tag number for the incoming message. *Redelivered* reflects whether the server is redelivering a message that is has delivered previously. *ExchangeName* reflects the name of the exchange to which the incoming message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, *ExchangeName* will also be empty.) *RoutingKey* reflects the routing key that the message was originally published with. *MessageCount* is always *-1* when this event fires due to a message being pushed to the struct by the server. When this event fires as a result of [retrieve_message](#retrieve_message-method-amqpclassic-struct) being called, *MessageCount* reflects the number of messages still available in the queue the struct tried to pull a message from (even if there were no messages available to pull). The *Accept* parameter can be set to control how the struct responds to the incoming message, if it needs to be acknowledged (if the message doesn't need to be acknowledged, the value set to the *Accept* parameter is ignored). Valid values are: - *0* - *default*: Accept the message; send a positive acknowledgment. - *1*: Silently accept the message; don't send any acknowledgment. - *2*: Accept the message; send a cumulative positive acknowledgment covering this, and all previously unacknowledged, messages. - *3*: Reject the message; send a negative acknowledgment for it, and instruct the server not to return it to the queue. - *4*: Reject the message; send a negative acknowledgment for it, and instruct the server to return it to the queue. If the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled, then the [NackMultiple](#NackMultiple) configuration setting can be used to control whether the two "reject" options (*3* and *4*) should function as cumulative or singular negative acknowledgements. By default [NackMultiple](#NackMultiple) is disabled, and all negative acknowledgements are singular. If the value provided for the *Accept* parameter isn't one of those described above, the default (*0*) will be used instead. **Receiving a Message** ```csharp // MessageIn event handler. amqpc1.OnMessageIn += (s, e) => { if (e.MessageCount == -1) { // The server pushed a message to us asynchronously due to a consumer we created. Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':"); Console.WriteLine(amqpc1.ReceivedMessage.Body); } else if (e.DeliveryTag > 0) { // We pulled a message from a queue with the RetrieveMessage() method. Console.WriteLine("Message successfully pulled:"); Console.WriteLine(amqpc1.ReceivedMessage.Body); Console.WriteLine(e.MessageCount + " messages are still available to pull."); } else { // We tried to pull a message, but there were none available to pull. Console.WriteLine("No messages available to pull."); } }; // Attach a consumer to "MyQueue". amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false); // Or, try to retrieve a message from "MyQueue". amqpc1.RetrieveMessage("channel", "MyQueue", true); ``` # on_message_out event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fires when a message is published. ## Syntax *Rust Syntax* ```text // AMQPClassicMessageOutEventArgs carries the AMQPClassic MessageOut event's parameters. pub struct AMQPClassicMessageOutEventArgs { fn channel_name(&self) -> &String fn exchange_name(&self) -> &String fn routing_key(&self) -> &String fn message_id(&self) -> &String fn delivery_tag(&self) -> i64 fn accepted(&self) -> bool } // AMQPClassicMessageOutEvent defines the signature of the AMQPClassic MessageOut event's handler function. pub trait AMQPClassicMessageOutEvent { fn on_message_out(&self, sender : AMQPClassic, e : &mut AMQPClassicMessageOutEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_message_out(&self) -> &'a dyn AMQPClassicMessageOutEvent; pub fn set_on_message_out(&mut self, value : &'a dyn AMQPClassicMessageOutEvent); ... } ``` ## Remarks This event fires anytime a message is published; or after an outgoing message has been acknowledged by the server, if the channel it was published on is in "publish confirmations" mode. *ChannelName* reflects the name of the channel the message was published on. *ExchangeName* reflects the name of the exchange the message was published to. (If the message was published to the server's default exchange, whose name is always the empty string, *ExchangeName* will also be empty.) *RoutingKey* reflects the routing key that the message was published with. *MessageId* reflects the message's unique Id, if one was set. *DeliveryTag* reflects the channel-specific delivery tag number for the message. (Note that this is only populated for messages published on a channel in "publish confirmations" mode; otherwise it will be set to *-1*.) *Accepted* indicates whether the server published back a positive *True* or negative *False* acknowledgment for the outgoing message. Note that this is only valid for messages published on a channel in "publish confirmations" mode; *Accepted* will always be *True* messages published on a channel in normal or transaction mode. Refer to [enable_publish_confirms](#enable_publish_confirms-method-amqpclassic-struct) for more information about channels in "publish confirmations" mode. # on_message_returned event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fires if a previously published message is returned by the server due to it being undeliverable. ## Syntax *Rust Syntax* ```text // AMQPClassicMessageReturnedEventArgs carries the AMQPClassic MessageReturned event's parameters. pub struct AMQPClassicMessageReturnedEventArgs { fn channel_name(&self) -> &String fn reply_code(&self) -> i32 fn reply_text(&self) -> &String fn exchange_name(&self) -> &String fn routing_key(&self) -> &String } // AMQPClassicMessageReturnedEvent defines the signature of the AMQPClassic MessageReturned event's handler function. pub trait AMQPClassicMessageReturnedEvent { fn on_message_returned(&self, sender : AMQPClassic, e : &mut AMQPClassicMessageReturnedEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_message_returned(&self) -> &'a dyn AMQPClassicMessageReturnedEvent; pub fn set_on_message_returned(&mut self, value : &'a dyn AMQPClassicMessageReturnedEvent); ... } ``` ## Remarks This event fires if the server returns a previously published message because it could not deliver it. Typically, messages are only undeliverable in one of the following situations: - The message was originally published with the *Mandatory* option enabled, but there were no queues it could be routed to. - The message was originally published with the *Immediate* option enabled, but there were no consumers it could be delivered to immediately on any queue it was routed to (or there were no queues it could be routed to). The received_message property will be populated with the returned message. *ChannelName* reflects the name of the channel the message was originally published on. *ReplyCode* will be an AMQP error code that indicates the reason why the message was returned. (Tip: The AMQPClassic struct's [Error Codes](#trappable-errors-amqpclassic-struct) page includes the various AMQP error codes.) *ReplyText* will be a message with further details about why the message was returned. *ExchangeName* reflects the name of the exchange to which the message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, *ExchangeName* will also be empty.) *RoutingKey* reflects the routing key that the message was originally published with. # on_ssl_server_authentication event ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fired after the server presents its certificate to the client. ## Syntax *Rust Syntax* ```text // AMQPClassicSSLServerAuthenticationEventArgs carries the AMQPClassic SSLServerAuthentication event's parameters. pub struct AMQPClassicSSLServerAuthenticationEventArgs { 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) } // AMQPClassicSSLServerAuthenticationEvent defines the signature of the AMQPClassic SSLServerAuthentication event's handler function. pub trait AMQPClassicSSLServerAuthenticationEvent { fn on_ssl_server_authentication(&self, sender : AMQPClassic, e : &mut AMQPClassicSSLServerAuthenticationEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_ssl_server_authentication(&self) -> &'a dyn AMQPClassicSSLServerAuthenticationEvent; pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn AMQPClassicSSLServerAuthenticationEvent); ... } ``` ## 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 ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) Fired when secure connection progress messages are available. ## Syntax *Rust Syntax* ```text // AMQPClassicSSLStatusEventArgs carries the AMQPClassic SSLStatus event's parameters. pub struct AMQPClassicSSLStatusEventArgs { fn message(&self) -> &String } // AMQPClassicSSLStatusEvent defines the signature of the AMQPClassic SSLStatus event's handler function. pub trait AMQPClassicSSLStatusEvent { fn on_ssl_status(&self, sender : AMQPClassic, e : &mut AMQPClassicSSLStatusEventArgs); } impl <'a> AMQPClassic<'a> { pub fn on_ssl_status(&self) -> &'a dyn AMQPClassicSSLStatusEvent; pub fn set_on_ssl_status(&mut self, value : &'a dyn AMQPClassicSSLStatusEvent); ... } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # Config Settings ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) The struct accepts one or more of the following *configuration settings*. Configuration 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](#config-method-amqpclassic-struct) method. ### AMQPClassic Config Settings **AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used.When [auth_scheme](#auth_scheme-property-amqpclassic-struct) is set to smSASLPlain you may use this setting to specify an authorization identity to be used when authenticating. **ConsumerTag**: The consumer tag associated with the most recently created consumer.Each time the [consume](#consume-method-amqpclassic-struct) method is called to create a new consumer, the server will send back a confirmation which includes the consumer tag value for that consumer, and the struct will update this setting's value accordingly. It is possible to pass empty string for the *ConsumerTag* parameter when calling the [consume](#consume-method-amqpclassic-struct) method, in which case the server will auto-generate a consumer tag. **Locale**: The desired message locale to use.This setting specifies the desired message locale, which will be compared to the server's list of supported message locales during the connection process. A connection attempt will fail if this setting is set to a locale not supported by the server. This setting cannot be changed while connected. The default value is "en_US", which is supported by all AMQP 0.9.1 servers. **Locales**: The message locales supported by the server.After a connection attempt (regardless of its success) this setting will reflect the various message locales that the server supports. The value of this setting is formatted as a space-separated list of message locales. **LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [on_log](#on_log-event-amqpclassic-struct) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | **MaxChannelCount**: The maximum number of channels.This setting specifies the maximum number of channels which can be opened. This setting cannot be changed while connected. The default is 65535 (0xFFFF). Note that this value is negotiated during the connection process; if the value provided by the server is lower than the specified value, the server's value will be used instead (and this setting will be updated accordingly). **MaxFrameSize**: The maximum frame size.This setting specifies the maximum frame size (in bytes) that the struct will accept. This setting cannot be changed while connected. The default is 2147483647 (0x7FFFFFFF). Note that this value is negotiated during the connection process; if the value provided by the server is lower than the specified value, the server's value will be used instead (and this setting will be updated accordingly). **Mechanisms**: The authentication mechanisms supported by the server.After a connection attempt (regardless of its success) this setting will reflect the various authentication mechanisms that the server supports. The value of this setting is formatted as a space-separated list of authentication mechanisms. **NackMultiple**: Whether negative acknowledgments should be cumulative or not.If the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is enabled, this setting controls whether the negative message acknowledgments the struct sends based on the value of the [on_message_in](#on_message_in-event-amqpclassic-struct) event's *Accept* parameter should be cumulative (*True*) or singular (*False - default*). This setting does nothing if the [RabbitMQCompatible](#RabbitMQCompatible) configuration setting is disabled. **ProtocolVersion**: The AMQP protocol version to conform to.This setting can be queried to determine what AMQP protocol version the struct conforms to. Note: Currently this setting will always return "0.9.1", and cannot be changed. The [AMQP](AMQP.md#AMQP) struct may be used instead of this one if AMQP 1.0 support is needed. **QueueConsumerCount**: The consumer count associated with the most recently created (or verified) queue.Each time the [declare_queue](#declare_queue-method-amqpclassic-struct) method is called successfully (and with its *NoWait* parameter set to *False*), the server returns information about the queue in question, causing the struct to update this setting with the number of consumers attached to that queue. **QueueName**: The queue name associated with the most recently created (or verified) queue.Each time the [declare_queue](#declare_queue-method-amqpclassic-struct) method is called successfully (and with its *NoWait* parameter set to *False*), the server returns information about the queue in question, causing the struct to update this setting with the name of that queue. It is possible to pass empty string for the *QueueName* parameter when calling the [declare_queue](#declare_queue-method-amqpclassic-struct) method to have the server create a new queue with an automatically generated name, which can then be retrieved by querying this setting. **RabbitMQCompatible**: Whether to operate in a mode compatible with RabbitMQ.This setting controls whether the struct will operate in such a way as to be compatible with RabbitMQ. When enabled, the struct complies with the parts of the [RabbitMQ AMQP 0.9.1 Errata](https://www.rabbitmq.com/amqp-0-9-1-errata.html) that are relevant to AMQP 0.9.1 client implementations, as well as offering additional features to support RabbitMQ-specific extensions to the AMQP 0.9.1 specification. The default is *True*. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [timeout](#timeout-property-amqpclassic-struct) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-amqpclassic-struct) setting 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 value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [local_host](#local_host-property-amqpclassic-struct) setting 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). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [local_port](#local_port-property-amqpclassic-struct) after the connection is established. [local_port](#local_port-property-amqpclassic-struct) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event-amqpclassic-struct) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the struct will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error. When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event-amqpclassic-struct) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property-amqpclassic-struct) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the struct when the [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property-amqpclassic-struct) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-amqpclassic-struct) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-amqpclassic-struct) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-amqpclassic-struct) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [ssl_provider](#ssl_provider-property-amqpclassic-struct) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-amqpclassic-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([AMQPClassic](#struct-ipworksiotamqpclassic) Struct) ### AMQPClassic Errors | | | | --- | --- | | 311 | AMQP Channel Error content-too-large: Content too large. | | 312 | AMQP Channel Error no-route: Cannot deliver message published with "mandatory" flag set; message cannot be routed to any queue. | | 313 | AMQP Channel Error no-consumers: Cannot deliver message published with "immediate" flag set; all possible queues are either non-empty or have no consumers. | | 320 | AMQP Connection Error connection-forced: Connection forced to close. | | 402 | AMQP Connection Error invalid-path: Invalid virtual host path specified. | | 403 | AMQP Channel Error access-refused: Attempted to work with a server entity (exchange, queue, etc.) without necessary permissions. | | 404 | AMQP Channel Error not-found: Attempted to work with a server entity (exchange, queue, etc.) that does not exist. | | 405 | AMQP Channel Error resource-locked: Attempted to work with a server entity (exchange, queue, etc.) that is currently locked by another client. | | 406 | AMQP Channel Error precondition-failed: Request failed due to one or more precondition failures. | | 501 | AMQP Connection Error frame-error: Server received an AMQP frame that it could not decode. | | 502 | AMQP Connection Error syntax-error: Server received an AMQP frame that contained illegal values for one or more fields. | | 503 | AMQP Connection Error command-invalid: Server received an invalid sequence of frame, attempting to perform an invalid operation. | | 504 | AMQP Connection Error channel-error: Attempted to work with a channel that does not exist (or was not opened correctly). | | 505 | AMQP Connection Error unexpected-frame: Server received a frame that was unexpected, typically with regards to the content header and body. | | 506 | AMQP Connection Error resource-error: Server could not complete the request due to insufficient resources. | | 530 | AMQP Connection Error not-allowed: Attempted to work with some server entity (exchange, queue, etc.) in a manner that is not allowed. | | 540 | AMQP Connection Error not-implemented: Requested an operation not supported by the server. | | 541 | AMQP Connection Error internal-error: The server encountered an internal error while attempting to process the request. | | 600 | General AMQP protocol error. Refer to the error message for more information. | | 601 | Cannot open another channel. | | 602 | Cannot modify message data. | | 603 | Cannot publish message on inactive channel. | | 604 | Action not supported. | | 606 | Cannot modify configuration setting. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the [remote_port](#remote_port-property-amqpclassic-struct) at this time. A connection is in progress. | | 101 | You cannot change the [remote_host](#remote_host-property-amqpclassic-struct) (Server) at this time. A connection is in progress. | | 102 | The [remote_host](#remote_host-property-amqpclassic-struct) address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the [local_port](#local_port-property-amqpclassic-struct) at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property-amqpclassic-struct) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | [remote_port](#remote_port-property-amqpclassic-struct) cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the struct is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |