Struct ipworksmq::AMQP

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Syntax

ipworksmq::AMQP

Remarks

The AMQP struct provides an easy-to-use AMQP 1.0 client implementation. The struct supports both plaintext and TLS-enabled connections over TCP.

Connecting

The struct implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the container_id property and call the connect_to method, passing it the server's hostname and port number.

Once connected, the next step is to create at least one session, which can be accomplished by using the create_session method. The struct allows creating any number of sessions, up to the limit specified by the MaxSessionCount configuration setting.

Connecting and Creating a Session amqp1.ContainerId = "testClient"; amqp1.ConnectTo("amqp.test-server.com", 5672); amqp1.CreateSession("TestSession");

After creating a session, the next step is to create one or more links (which are created in the context of a session) so that messages can be sent and/or received. Links are unidirectional, so each one has a sender on one end and a receiver on the other.

The struct can function both as a sender node (by opening sender links) and as a receiver node (by opening receiver links). But keep in mind that, since the struct is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the struct cannot accept any link requests made by other peers).

As with sessions, the struct allows creating any number of links for each session, up to the limit specified by the MaxLinkCountPerSession configuration setting.

Creating Sender Links

The on_link_ready_to_send event will fire when the newly created sender link is ready to send messages.

Creating a Sender Link amqp1.OnLinkReadyToSend += (s, e) => { Console.WriteLine("Link '" + e.LinkName + "' is ready to send messages!"); }; amqp1.CreateSenderLink("TestSession", "TestSenderLink", "TestTarget");

Sending Messages

At minimum, the message_value and message_value_type properties must be set. All other properties are optional, though specifying a unique value for message_id is recommended. (If the GenerateMessageId configuration setting is enabled, the struct will generate one automatically when the message is sent.)

Once the message property's properties have be assigned as desired, call the send_message method, passing it the name of an existing sender link on which the message should be sent.

The on_message_out event will be fired when the message has been sent (and acknowledged, if message_settled was set to false). The on_message_outcome event may also fire, if necessary, once the receiver reports the outcome of the message.

Refer to send_message, on_message_out, and on_message_outcome for more information.

Sending a Message amqp1.OnMessageOut += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been sent on link '" + e.LinkName + "'."); }; amqp1.Message.MessageId = "TestMessageId"; amqp1.Message.Value = "Hello, world!"; amqp1.Message.ValueType = AMQPValueTypes.mvtString; amqp1.SendMessage("TestSenderLink");

The reset_message method can be used to reset the message property's properties to their default values.

Sending Composite AMQP Data

The struct supports sending composite AMQP data in a message through the use of JSON with a well-defined schema. Refer to the send_message method's documentation for more information and examples.

Creating Receiver Links

The receive_mode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.

After ensuring that receive_mode is set as desired, call create_receiver_link, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a source for the sender to route the link creation request to.

Creating a Receiver Link // Creating an automatic receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmAutomatic; amqp1.CreateReceiverLink("TestSession", "TestAutoReceiverLink", "TestSource1"); // Creating a retrieve-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp1.CreateReceiverLink("TestSession", "TestRetrieveReceiverLink", "TestSource2");

Receiving Messages

For receiver links created in retrieve-based mode, the struct will attempt to "retrieve" a message each time the retrieve_message method is called (optionally timing out after a time, if retrieve_timeout is non-zero). When calling retrieve_message, pass it the name of a retrieve-based receiver link.

Regardless of whether a messages is received automatically or retrieved, any incoming message will cause the struct to fire the on_message_in event and update the received_message property's properties.

When the on_message_in event fires, its State event parameter can be used to specify the outcome of the message, which the struct will then transmit back to the sender (as well as self-report by firing the on_message_outcome event). Refer to on_message_in for more information.

Receiving a Message // For automatic receiver links, only the event handler is necessary. amqp1.OnMessageIn += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been received on link '" + e.LinkName + "'. Value:"); Console.WriteLine(amqp1.ReceivedMessage.Value); // The message state is already set to the "Accepted" outcome by default, but we'll set it again // for the purpose of this example. e.State = 0; // 0 = Accepted. }; // For retrieve-based links, it's also necessary to call RetrieveMessage(). It is recommended that the // RetrieveTimeout property be set to a non-zero value (60 seconds is the default) so that the retrieve // request will eventually time out if the sender doesn't have any messages available to deliver. amqp1.RetrieveTimeout = 60; amqp1.RetrieveMessage("TestRetrieveReceiverLink");

Object Lifetime

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

Property List

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

Method List

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

Event List

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

Config Settings

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

auth_scheme property (AMQP Struct)

The authentication scheme to use when connecting.

Syntax

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

Possible Values

0   // None
1   // SASLAnonymous
2   // SASLPlain
3   // 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

connected property (AMQP Struct)

This property indicates whether the struct is connected.

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

container_id property (AMQP Struct)

The container Id the struct should advertise when connecting.

Syntax

fn container_id(&self ) -> Result<String, IPWorksMQError> 
fn set_container_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_container_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This property specifies the container Id that the struct should advertise when it's connecting to the remote host.

In AMQP, the top-level organizational grouping is called a "container", and each container can contain zero or more "nodes", which are the actual entities which send and receive messages over links.

Since this struct handles multiple layers of the AMQP transport protocol (the overall connection, the sessions in that connection, and the links attached to those sessions), it must be given a unique container Id.

NOTE: The container Id cannot be changed while connected.

Data Type

String

firewall_auto_detect property (AMQP Struct)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

firewall_type property (AMQP Struct)

The type of firewall to connect through.

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

Data Type

i32

firewall_host property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

firewall_password property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

firewall_port property (AMQP Struct)

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

Syntax

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

Default Value

0

Remarks

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

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

Data Type

i32

firewall_user property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

idle_timeout property (AMQP Struct)

The maximum period of inactivity the struct will allow before disconnecting.

Syntax

fn idle_timeout(&self ) -> Result<i32, IPWorksMQError> 
fn set_idle_timeout(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

This property controls how long, in seconds, the struct will allow the connection to sit idle before it disconnects from the remote host.

This property may be set to 0 to prevent the struct from ever closing the connection due to inactivity.

NOTE: The idle timeout cannot be changed while connected.

Data Type

i32

incoming_message_count property (AMQP Struct)

The number of records in the IncomingMessage arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• incoming_message_absolute_expiry_time
• incoming_message_content_encoding
• incoming_message_content_type
• incoming_message_correlation_id
• incoming_message_creation_time
• incoming_message_delivery_count
• incoming_message_durable
• incoming_message_first_acquirer
• incoming_message_group_id
• incoming_message_group_sequence
• incoming_message_id
• incoming_message_link_name
• incoming_message_priority
• incoming_message_reply_to
• incoming_message_reply_to_group_id
• incoming_message_settled
• incoming_message_subject
• incoming_message_to
• incoming_message_ttl
• incoming_message_user_id
• incoming_message_value
• incoming_message_value_type

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

This property is read-only.

Data Type

i32

incoming_message_absolute_expiry_time property (AMQP Struct)

The absolute time at which this message should be considered expired.

Syntax

fn incoming_message_absolute_expiry_time(&self , IncomingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

i64

incoming_message_content_encoding property (AMQP Struct)

The content encoding of this message's data.

Syntax

fn incoming_message_content_encoding(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if incoming_message_value_type is not set to mvtData (20).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_content_type property (AMQP Struct)

The content type of this message's data.

Syntax

fn incoming_message_content_type(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if incoming_message_value_type is not set to mvtData (20).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_correlation_id property (AMQP Struct)

The correlation Id of this message.

Syntax

fn incoming_message_correlation_id(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_creation_time property (AMQP Struct)

The creation time of this message.

Syntax

fn incoming_message_creation_time(&self , IncomingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

i64

incoming_message_delivery_count property (AMQP Struct)

How many previous attempts there have been to deliver this message.

Syntax

fn incoming_message_delivery_count(&self , IncomingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

i64

incoming_message_durable property (AMQP Struct)

Whether this message is durable.

Syntax

fn incoming_message_durable(&self , IncomingMessageIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

bool

incoming_message_first_acquirer property (AMQP Struct)

Whether this message may have been acquired by other links previously.

Syntax

fn incoming_message_first_acquirer(&self , IncomingMessageIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

bool

incoming_message_group_id property (AMQP Struct)

The Id of the group this message belongs to.

Syntax

fn incoming_message_group_id(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_group_sequence property (AMQP Struct)

The position of this message within its group.

Syntax

fn incoming_message_group_sequence(&self , IncomingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

i64

incoming_message_link_name property (AMQP Struct)

The name of the link this message is associated with.

Syntax

fn incoming_message_link_name(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_id property (AMQP Struct)

The unique Id of this message.

Syntax

fn incoming_message_id(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The unique Id of this message.

This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_priority property (AMQP Struct)

The priority of this message.

Syntax

fn incoming_message_priority(&self , IncomingMessageIndex : i32) -> Result<i32, IPWorksMQError> 

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

i32

incoming_message_reply_to property (AMQP Struct)

The address of the node to send replies to for this message.

Syntax

fn incoming_message_reply_to(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_reply_to_group_id property (AMQP Struct)

The Id of the group to send replies to for this message.

Syntax

fn incoming_message_reply_to_group_id(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_settled property (AMQP Struct)

Whether this message is settled.

Syntax

fn incoming_message_settled(&self , IncomingMessageIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

bool

incoming_message_subject property (AMQP Struct)

The subject of this message.

Syntax

fn incoming_message_subject(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_to property (AMQP Struct)

The address of the node which this message is intended for.

Syntax

fn incoming_message_to(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_ttl property (AMQP Struct)

The time-to-live value for this message.

Syntax

fn incoming_message_ttl(&self , IncomingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

-1

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

This property is read-only.

Data Type

i64

incoming_message_user_id property (AMQP Struct)

The identity of the user responsible for producing this message.

Syntax

fn incoming_message_user_id(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The identity of the user responsible for producing this message.

This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.

A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_value property (AMQP Struct)

This message's value.

Syntax

fn incoming_message_value(&self , IncomingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The incoming_message_value_type property should be used to specify the data type of the value.

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

String

incoming_message_value_type property (AMQP Struct)

This message's value data type.

Syntax

fn incoming_message_value_type(&self , IncomingMessageIndex : i32) -> Result<i32, IPWorksMQError> 

Possible Values

0   // Null
1   // Boolean
2   // Ubyte
3   // Ushort
4   // Uint
5   // Ulong
6   // Byte
7   // Short
8   // Int
9   // Long
10   // Float
11   // Double
12   // Decimal
13   // Char
14   // Timestamp
15   // Uuid
16   // Binary
17   // String
18   // Symbol
19   // Json
20   // Data

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's incoming_message_value.

The table below shows the possible value types, their descriptions, and how to format the data assigned to incoming_message_value. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

The IncomingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only.

Data Type

i32

link_count property (AMQP Struct)

The number of records in the Link arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• link_available
• link_channel_name
• link_credit
• link_delivery_count
• link_name
• link_ready_to_send
• link_receive_mode
• link_role

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

This property is read-only.

Data Type

i32

link_available property (AMQP Struct)

The number of messages which this link's sender could send if it had credit for them.

Syntax

fn link_available(&self , LinkIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The number of messages which this link's sender could send if it had credit for them.

This property returns the number of messages which this link's sender has indicated that it could send if it had the credit to do so.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

i64

link_channel_name property (AMQP Struct)

The channel name this link is using.

Syntax

fn link_channel_name(&self , LinkIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The channel name this link is using.

This property holds the channel name this link is using.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

String

link_credit property (AMQP Struct)

The amount of credit currently available to this link's sender.

Syntax

fn link_credit(&self , LinkIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The amount of credit currently available to this link's sender.

This property holds the amount of credit currently available to this link's sender. The sender on a link can only send messages if it has non-zero credit.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

i64

link_delivery_count property (AMQP Struct)

The current delivery count value for this link.

Syntax

fn link_delivery_count(&self , LinkIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The current delivery count value for this link.

This property holds the current delivery count value for this link.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

i64

link_name property (AMQP Struct)

This link's name.

Syntax

fn link_name(&self , LinkIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This link's name.

This property holds this link's name.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

String

link_ready_to_send property (AMQP Struct)

Whether this link is ready to send a message.

Syntax

fn link_ready_to_send(&self , LinkIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether this link is ready to send a message.

This property reflects whether this link is currently ready to send a message or not; it always returns False if link_role is lrReceiver (1).

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

bool

link_receive_mode property (AMQP Struct)

The receive mode this link is operating in.

Syntax

fn link_receive_mode(&self , LinkIndex : i32) -> Result<i32, IPWorksMQError> 

Possible Values

0   // Automatic
1   // Retrieve

Default Value

0

Remarks

The receive mode this link is operating in.

This property reflects the receive mode which this link is operating in, if it is a receiver link. (For sender links, this property's value means nothing.) Values can be:

• lrmAutomatic - Messages will be received automatically
• lrmRetrieve - One message will be received after each call to the RetrieveMessage method.

Refer to receive_mode for more information.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

i32

link_role property (AMQP Struct)

The struct's role on this link.

Syntax

fn link_role(&self , LinkIndex : i32) -> Result<i32, IPWorksMQError> 

Possible Values

0   // Sender
1   // Receiver

Default Value

0

Remarks

The struct's role on this link.

This property reflects which role the struct is in for this link. Valid values are:

• lrSender (0)
• lrReceiver (1)

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

This property is read-only.

Data Type

i32

local_host property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

local_port property (AMQP Struct)

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

Syntax

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

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_absolute_expiry_time property (AMQP Struct)

The absolute time at which this message should be considered expired.

Syntax

fn message_absolute_expiry_time(&self ) -> Result<i64, IPWorksMQError> 
fn set_message_absolute_expiry_time(&self, value : i64) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

Data Type

i64

message_content_encoding property (AMQP Struct)

The content encoding of this message's data.

Syntax

fn message_content_encoding(&self ) -> Result<String, IPWorksMQError> 
fn set_message_content_encoding(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_content_encoding_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if message_value_type is not set to mvtData (20).

Data Type

String

message_content_type property (AMQP Struct)

The content type of this message's data.

Syntax

fn message_content_type(&self ) -> Result<String, IPWorksMQError> 
fn set_message_content_type(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_content_type_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if message_value_type is not set to mvtData (20).

Data Type

String

message_correlation_id property (AMQP Struct)

The correlation Id of this message.

Syntax

fn message_correlation_id(&self ) -> Result<String, IPWorksMQError> 
fn set_message_correlation_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_correlation_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

Data Type

String

message_creation_time property (AMQP Struct)

The creation time of this message.

Syntax

fn message_creation_time(&self ) -> Result<i64, IPWorksMQError> 
fn set_message_creation_time(&self, value : i64) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

Data Type

i64

message_delivery_count property (AMQP Struct)

How many previous attempts there have been to deliver this message.

Syntax

fn message_delivery_count(&self ) -> Result<i64, IPWorksMQError> 
fn set_message_delivery_count(&self, value : i64) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

Data Type

i64

message_durable property (AMQP Struct)

Whether this message is durable.

Syntax

fn message_durable(&self ) -> Result<bool, IPWorksMQError> 
fn set_message_durable(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

Data Type

bool

message_first_acquirer property (AMQP Struct)

Whether this message may have been acquired by other links previously.

Syntax

fn message_first_acquirer(&self ) -> Result<bool, IPWorksMQError> 
fn set_message_first_acquirer(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

Data Type

bool

message_group_id property (AMQP Struct)

The Id of the group this message belongs to.

Syntax

fn message_group_id(&self ) -> Result<String, IPWorksMQError> 
fn set_message_group_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_group_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

Data Type

String

message_group_sequence property (AMQP Struct)

The position of this message within its group.

Syntax

fn message_group_sequence(&self ) -> Result<i64, IPWorksMQError> 
fn set_message_group_sequence(&self, value : i64) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

Data Type

i64

message_link_name property (AMQP Struct)

The name of the link this message is associated with.

Syntax

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

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

This property is read-only.

Data Type

String

message_id property (AMQP Struct)

The unique Id of this message.

Syntax

fn message_id(&self ) -> Result<String, IPWorksMQError> 
fn set_message_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The unique Id of this message.

This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.

Data Type

String

message_priority property (AMQP Struct)

The priority of this message.

Syntax

fn message_priority(&self ) -> Result<i32, IPWorksMQError> 
fn set_message_priority(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

Data Type

i32

message_reply_to property (AMQP Struct)

The address of the node to send replies to for this message.

Syntax

fn message_reply_to(&self ) -> Result<String, IPWorksMQError> 
fn set_message_reply_to(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_reply_to_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

Data Type

String

message_reply_to_group_id property (AMQP Struct)

The Id of the group to send replies to for this message.

Syntax

fn message_reply_to_group_id(&self ) -> Result<String, IPWorksMQError> 
fn set_message_reply_to_group_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_reply_to_group_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

Data Type

String

message_settled property (AMQP Struct)

Whether this message is settled.

Syntax

fn message_settled(&self ) -> Result<bool, IPWorksMQError> 
fn set_message_settled(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

Data Type

bool

message_subject property (AMQP Struct)

The subject of this message.

Syntax

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

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

Data Type

String

message_to property (AMQP Struct)

The address of the node which this message is intended for.

Syntax

fn message_to(&self ) -> Result<String, IPWorksMQError> 
fn set_message_to(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_to_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

Data Type

String

message_ttl property (AMQP Struct)

The time-to-live value for this message.

Syntax

fn message_ttl(&self ) -> Result<i64, IPWorksMQError> 
fn set_message_ttl(&self, value : i64) ->  Option<IPWorksMQError> 

Default Value

-1

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

i64

message_user_id property (AMQP Struct)

The identity of the user responsible for producing this message.

Syntax

fn message_user_id(&self ) -> Result<String, IPWorksMQError> 
fn set_message_user_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_user_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The identity of the user responsible for producing this message.

This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.

A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.

Data Type

String

message_value property (AMQP Struct)

This message's value.

Syntax

fn message_value(&self ) -> Result<String, IPWorksMQError> 
fn set_message_value(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_message_value_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The message_value_type property should be used to specify the data type of the value.

Data Type

String

message_value_type property (AMQP Struct)

This message's value data type.

Syntax

fn message_value_type(&self ) -> Result<i32, IPWorksMQError> 
fn set_message_value_type(&self, value : i32) ->  Option<IPWorksMQError> 

Possible Values

0   // Null
1   // Boolean
2   // Ubyte
3   // Ushort
4   // Uint
5   // Ulong
6   // Byte
7   // Short
8   // Int
9   // Long
10   // Float
11   // Double
12   // Decimal
13   // Char
14   // Timestamp
15   // Uuid
16   // Binary
17   // String
18   // Symbol
19   // Json
20   // Data

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's message_value.

The table below shows the possible value types, their descriptions, and how to format the data assigned to message_value. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

Data Type

i32

outgoing_message_count property (AMQP Struct)

The number of records in the OutgoingMessage arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• outgoing_message_absolute_expiry_time
• outgoing_message_content_encoding
• outgoing_message_content_type
• outgoing_message_correlation_id
• outgoing_message_creation_time
• outgoing_message_delivery_count
• outgoing_message_durable
• outgoing_message_first_acquirer
• outgoing_message_group_id
• outgoing_message_group_sequence
• outgoing_message_id
• outgoing_message_link_name
• outgoing_message_priority
• outgoing_message_reply_to
• outgoing_message_reply_to_group_id
• outgoing_message_settled
• outgoing_message_subject
• outgoing_message_to
• outgoing_message_ttl
• outgoing_message_user_id
• outgoing_message_value
• outgoing_message_value_type

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

This property is read-only.

Data Type

i32

outgoing_message_absolute_expiry_time property (AMQP Struct)

The absolute time at which this message should be considered expired.

Syntax

fn outgoing_message_absolute_expiry_time(&self , OutgoingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

i64

outgoing_message_content_encoding property (AMQP Struct)

The content encoding of this message's data.

Syntax

fn outgoing_message_content_encoding(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if outgoing_message_value_type is not set to mvtData (20).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_content_type property (AMQP Struct)

The content type of this message's data.

Syntax

fn outgoing_message_content_type(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if outgoing_message_value_type is not set to mvtData (20).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_correlation_id property (AMQP Struct)

The correlation Id of this message.

Syntax

fn outgoing_message_correlation_id(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_creation_time property (AMQP Struct)

The creation time of this message.

Syntax

fn outgoing_message_creation_time(&self , OutgoingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

i64

outgoing_message_delivery_count property (AMQP Struct)

How many previous attempts there have been to deliver this message.

Syntax

fn outgoing_message_delivery_count(&self , OutgoingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

i64

outgoing_message_durable property (AMQP Struct)

Whether this message is durable.

Syntax

fn outgoing_message_durable(&self , OutgoingMessageIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

bool

outgoing_message_first_acquirer property (AMQP Struct)

Whether this message may have been acquired by other links previously.

Syntax

fn outgoing_message_first_acquirer(&self , OutgoingMessageIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

bool

outgoing_message_group_id property (AMQP Struct)

The Id of the group this message belongs to.

Syntax

fn outgoing_message_group_id(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_group_sequence property (AMQP Struct)

The position of this message within its group.

Syntax

fn outgoing_message_group_sequence(&self , OutgoingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

i64

outgoing_message_link_name property (AMQP Struct)

The name of the link this message is associated with.

Syntax

fn outgoing_message_link_name(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_id property (AMQP Struct)

The unique Id of this message.

Syntax

fn outgoing_message_id(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The unique Id of this message.

This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_priority property (AMQP Struct)

The priority of this message.

Syntax

fn outgoing_message_priority(&self , OutgoingMessageIndex : i32) -> Result<i32, IPWorksMQError> 

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

i32

outgoing_message_reply_to property (AMQP Struct)

The address of the node to send replies to for this message.

Syntax

fn outgoing_message_reply_to(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_reply_to_group_id property (AMQP Struct)

The Id of the group to send replies to for this message.

Syntax

fn outgoing_message_reply_to_group_id(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_settled property (AMQP Struct)

Whether this message is settled.

Syntax

fn outgoing_message_settled(&self , OutgoingMessageIndex : i32) -> Result<bool, IPWorksMQError> 

Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

bool

outgoing_message_subject property (AMQP Struct)

The subject of this message.

Syntax

fn outgoing_message_subject(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_to property (AMQP Struct)

The address of the node which this message is intended for.

Syntax

fn outgoing_message_to(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_ttl property (AMQP Struct)

The time-to-live value for this message.

Syntax

fn outgoing_message_ttl(&self , OutgoingMessageIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

-1

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

This property is read-only.

Data Type

i64

outgoing_message_user_id property (AMQP Struct)

The identity of the user responsible for producing this message.

Syntax

fn outgoing_message_user_id(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The identity of the user responsible for producing this message.

This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.

A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_value property (AMQP Struct)

This message's value.

Syntax

fn outgoing_message_value(&self , OutgoingMessageIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The outgoing_message_value_type property should be used to specify the data type of the value.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

String

outgoing_message_value_type property (AMQP Struct)

This message's value data type.

Syntax

fn outgoing_message_value_type(&self , OutgoingMessageIndex : i32) -> Result<i32, IPWorksMQError> 

Possible Values

0   // Null
1   // Boolean
2   // Ubyte
3   // Ushort
4   // Uint
5   // Ulong
6   // Byte
7   // Short
8   // Int
9   // Long
10   // Float
11   // Double
12   // Decimal
13   // Char
14   // Timestamp
15   // Uuid
16   // Binary
17   // String
18   // Symbol
19   // Json
20   // Data

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's outgoing_message_value.

The table below shows the possible value types, their descriptions, and how to format the data assigned to outgoing_message_value. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only.

Data Type

i32

password property (AMQP Struct)

A password to use for SASL authentication.

Syntax

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

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

Data Type

String

ready_to_send property (AMQP Struct)

Indicates whether the struct is ready to send data.

Syntax

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

Default Value

false

Remarks

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after connecting to the remote host, and will become False if a call to send_message fails due to a WOULDBLOCK condition.

Once data can be sent again, the on_ready_to_send event will fire and this property will be True.

If a WOULDBLOCK error occurs while sending a message the struct will automatically complete the transmission when sending is possible. No action needs to be taken to re-send the message. on_ready_to_send will fire after the struct completes any partially sent messages.

This property is read-only.

Data Type

bool

received_message_absolute_expiry_time property (AMQP Struct)

The absolute time at which this message should be considered expired.

Syntax

fn received_message_absolute_expiry_time(&self ) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

This property is read-only.

Data Type

i64

received_message_content_encoding property (AMQP Struct)

The content encoding of this message's data.

Syntax

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

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if received_message_value_type is not set to mvtData (20).

This property is read-only.

Data Type

String

received_message_content_type property (AMQP Struct)

The content type of this message's data.

Syntax

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

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if received_message_value_type is not set to mvtData (20).

This property is read-only.

Data Type

String

received_message_correlation_id property (AMQP Struct)

The correlation Id of this message.

Syntax

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

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

This property is read-only.

Data Type

String

received_message_creation_time property (AMQP Struct)

The creation time of this message.

Syntax

fn received_message_creation_time(&self ) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

This property is read-only.

Data Type

i64

received_message_delivery_count property (AMQP Struct)

How many previous attempts there have been to deliver this message.

Syntax

fn received_message_delivery_count(&self ) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

This property is read-only.

Data Type

i64

received_message_durable property (AMQP Struct)

Whether this message is durable.

Syntax

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

Default Value

false

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

This property is read-only.

Data Type

bool

received_message_first_acquirer property (AMQP Struct)

Whether this message may have been acquired by other links previously.

Syntax

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

Default Value

false

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

This property is read-only.

Data Type

bool

received_message_group_id property (AMQP Struct)

The Id of the group this message belongs to.

Syntax

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

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

This property is read-only.

Data Type

String

received_message_group_sequence property (AMQP Struct)

The position of this message within its group.

Syntax

fn received_message_group_sequence(&self ) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

This property is read-only.

Data Type

i64

received_message_link_name property (AMQP Struct)

The name of the link this message is associated with.

Syntax

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

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

This property is read-only.

Data Type

String

received_message_id property (AMQP Struct)

The unique Id of this message.

Syntax

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

Default Value

""

Remarks

The unique Id of this message.

This property holds the unique Id of this message. It may be empty if this message does not have a unique Id.

This property is read-only.

Data Type

String

received_message_priority property (AMQP Struct)

The priority of this message.

Syntax

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

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

This property is read-only.

Data Type

i32

received_message_reply_to property (AMQP Struct)

The address of the node to send replies to for this message.

Syntax

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

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

This property is read-only.

Data Type

String

received_message_reply_to_group_id property (AMQP Struct)

The Id of the group to send replies to for this message.

Syntax

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

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

This property is read-only.

Data Type

String

received_message_settled property (AMQP Struct)

Whether this message is settled.

Syntax

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

Default Value

true

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

This property is read-only.

Data Type

bool

received_message_subject property (AMQP Struct)

The subject of this message.

Syntax

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

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

This property is read-only.

Data Type

String

received_message_to property (AMQP Struct)

The address of the node which this message is intended for.

Syntax

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

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

This property is read-only.

Data Type

String

received_message_ttl property (AMQP Struct)

The time-to-live value for this message.

Syntax

fn received_message_ttl(&self ) -> Result<i64, IPWorksMQError> 

Default Value

-1

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

i64

received_message_user_id property (AMQP Struct)

The identity of the user responsible for producing this message.

Syntax

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

Default Value

""

Remarks

The identity of the user responsible for producing this message.

This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.

A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.

This property is read-only.

Data Type

String

received_message_value property (AMQP Struct)

This message's value.

Syntax

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

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The received_message_value_type property should be used to specify the data type of the value.

This property is read-only.

Data Type

String

received_message_value_type property (AMQP Struct)

This message's value data type.

Syntax

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

Possible Values

0   // Null
1   // Boolean
2   // Ubyte
3   // Ushort
4   // Uint
5   // Ulong
6   // Byte
7   // Short
8   // Int
9   // Long
10   // Float
11   // Double
12   // Decimal
13   // Char
14   // Timestamp
15   // Uuid
16   // Binary
17   // String
18   // Symbol
19   // Json
20   // Data

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's received_message_value.

The table below shows the possible value types, their descriptions, and how to format the data assigned to received_message_value. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

This property is read-only.

Data Type

i32

receive_mode property (AMQP Struct)

Controls what mode new receiver links are created with.

Syntax

fn receive_mode(&self ) -> Result<i32, IPWorksMQError> 
fn set_receive_mode(&self, value : i32) ->  Option<IPWorksMQError> 

Possible Values

0   // Automatic
1   // Retrieve

Default Value

0

Remarks

This property controls which receive mode newly created receiver links should use to receive messages from the sender. Valid values are:

• rmAutomatic (0 - default)
• rmRetrieve (1)

Receiving Messages Automatically

In this mode, receiver links will be created with the amount of credit, and the credit threshold, specified by the DefaultCredit and DefaultCreditThreshold configuration settings. Anytime the link's credit reaches the credit threshold, the struct will automatically set it back to its initial value.

Retrieving Messages On-Demand

In this mode, receiver links will be created with no credit (regardless of what DefaultCredit is set to). When retrieve_message is called, the struct will supply the sender with a single credit and then block until a message is received (if the retrieve_timeout property is set to zero).

If retrieve_timeout is non-zero, the struct will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the LinkDeliveryCount property rather than by sending a message, then the struct will throw an error indicating a timeout.

Refer to retrieve_message and retrieve_timeout for more information. amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

Data Type

i32

remote_host property (AMQP Struct)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

fn remote_host(&self ) -> Result<String, IPWorksMQError> 
fn set_remote_host(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_remote_host_ref(&self, value : &String) ->  Option<IPWorksMQError> 

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:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Data Type

String

remote_port property (AMQP Struct)

The port of the AMQP server (default is 5672). The default port for SSL is 5671.

Syntax

fn remote_port(&self ) -> Result<i32, IPWorksMQError> 
fn set_remote_port(&self, value : i32) ->  Option<IPWorksMQError> 

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

retrieve_timeout property (AMQP Struct)

How long the struct should wait for a message to be received after RetrieveMessage is called.

Syntax

fn retrieve_timeout(&self ) -> Result<i32, IPWorksMQError> 
fn set_retrieve_timeout(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

60

Remarks

This property controls how long, in seconds, the struct will wait for a message to be received after retrieve_message is called before timing out the request. If set to zero, the struct will wait indefinitely.

Refer to retrieve_message for more information.

Data Type

i32

session_count property (AMQP Struct)

The number of records in the Session arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• session_incoming_window
• session_name
• session_outgoing_window

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

This property is read-only.

Data Type

i32

session_incoming_window property (AMQP Struct)

The incoming window size of this session.

Syntax

fn session_incoming_window(&self , SessionIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The incoming window size of this session.

This property holds the incoming window size (in frames) of this session.

The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

This property is read-only.

Data Type

i64

session_name property (AMQP Struct)

The name of this session.

Syntax

fn session_name(&self , SessionIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of this session.

This property holds the name of this session.

The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

This property is read-only.

Data Type

String

session_outgoing_window property (AMQP Struct)

The outgoing window size of this session.

Syntax

fn session_outgoing_window(&self , SessionIndex : i32) -> Result<i64, IPWorksMQError> 

Default Value

0

Remarks

The outgoing window size of this session.

This property holds the outgoing window size (in frames) of this session.

The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

This property is read-only.

Data Type

i64

ssl_accept_server_cert_effective_date property (AMQP Struct)

The date on which this certificate becomes valid.

Syntax

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

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (AMQP Struct)

The date on which the certificate expires.

Syntax

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

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (AMQP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (AMQP Struct)

The issuer of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (AMQP Struct)

The private key of the certificate (if available).

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (AMQP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (AMQP Struct)

The public key of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (AMQP Struct)

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

Syntax

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

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (AMQP Struct)

The serial number of the certificate encoded as a string.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (AMQP Struct)

The text description of the certificate's signature algorithm.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (AMQP Struct)

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

ssl_accept_server_cert_store_password property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

ssl_accept_server_cert_store_type property (AMQP Struct)

The type of certificate store for this certificate.

Syntax

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

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (AMQP Struct)

The MD5 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (AMQP Struct)

The SHA-1 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (AMQP Struct)

The SHA-256 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (AMQP Struct)

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (AMQP Struct)

The flags that show intended use for the certificate.

Syntax

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

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (AMQP Struct)

The certificate's version number.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (AMQP Struct)

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

ssl_accept_server_cert_encoded property (AMQP Struct)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

Data Type

Vec

ssl_cert_effective_date property (AMQP Struct)

The date on which this certificate becomes valid.

Syntax

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

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (AMQP Struct)

The date on which the certificate expires.

Syntax

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

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (AMQP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_issuer property (AMQP Struct)

The issuer of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_private_key property (AMQP Struct)

The private key of the certificate (if available).

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (AMQP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key property (AMQP Struct)

The public key of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (AMQP Struct)

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

Syntax

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

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (AMQP Struct)

The serial number of the certificate encoded as a string.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (AMQP Struct)

The text description of the certificate's signature algorithm.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_store property (AMQP Struct)

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Vec

ssl_cert_store_password property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

ssl_cert_store_type property (AMQP Struct)

The type of certificate store for this certificate.

Syntax

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

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_cert_subject_alt_names property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (AMQP Struct)

The MD5 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (AMQP Struct)

The SHA-1 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (AMQP Struct)

The SHA-256 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_usage property (AMQP Struct)

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (AMQP Struct)

The flags that show intended use for the certificate.

Syntax

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

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

i32

ssl_cert_version property (AMQP Struct)

The certificate's version number.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_subject property (AMQP Struct)

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

ssl_cert_encoded property (AMQP Struct)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

Data Type

Vec

ssl_enabled property (AMQP Struct)

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

Syntax

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

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

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

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

i32

ssl_server_cert_effective_date property (AMQP Struct)

The date on which this certificate becomes valid.

Syntax

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

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (AMQP Struct)

The date on which the certificate expires.

Syntax

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

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (AMQP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (AMQP Struct)

The issuer of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (AMQP Struct)

The private key of the certificate (if available).

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (AMQP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (AMQP Struct)

The public key of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (AMQP Struct)

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

Syntax

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

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (AMQP Struct)

The serial number of the certificate encoded as a string.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (AMQP Struct)

The text description of the certificate's signature algorithm.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_store property (AMQP Struct)

The name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (AMQP Struct)

The type of certificate store for this certificate.

Syntax

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

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (AMQP Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (AMQP Struct)

The MD5 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (AMQP Struct)

The SHA-1 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (AMQP Struct)

The SHA-256 hash of the certificate.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_usage property (AMQP Struct)

The text description of UsageFlags .

Syntax

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

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

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

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

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (AMQP Struct)

The flags that show intended use for the certificate.

Syntax

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

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

i32

ssl_server_cert_version property (AMQP Struct)

The certificate's version number.

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_subject property (AMQP Struct)

The subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (AMQP Struct)

The certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

Vec

timeout property (AMQP Struct)

This property includes the timeout for the struct.

Syntax

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the timeout property is 60 seconds.

Data Type

i32

user property (AMQP Struct)

A username to use for SASL authentication.

Syntax

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

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

Data Type

String

close_link method (AMQP Struct)

Closes a link.

Syntax

fn close_link(&self, name : &str) -> Result<(), IPWorksMQError>

Remarks

This method closes the link named Name and removes it from the links properties. If no link with the given Name exists, an error will be thrown.

close_session method (AMQP Struct)

Closes a session.

Syntax

fn close_session(&self, name : &str) -> Result<(), IPWorksMQError>

Remarks

This method closes the session named Name and removes it from the sessions properties. If no session with the given Name exists, an error will be thrown.

Any links open on the specified session when this method is called will be automatically closed and removed from the links properties.

config method (AMQP Struct)

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

connect method (AMQP Struct)

This method connects to a remote host.

Syntax

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

Remarks

This method connects to the remote host specified by remote_host and remote_port. For instance: component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect();

connect_to method (AMQP Struct)

This method connects to a remote host.

Syntax

fn connect_to(&self, host : &str, port : i32) -> Result<(), IPWorksMQError>

Remarks

This method connects to the remote host specified by the host and port parameters. For instance: component.ConnectTo("MyHostNameOrIP", 777)

create_receiver_link method (AMQP Struct)

Creates a new receiver link with the given name on the specified session.

Syntax

fn create_receiver_link(&self, session_name : &str, name : &str, source : &str) -> Result<(), IPWorksMQError>

Remarks

This method creates a new receiver link with the given Name on the session specified by SessionName and adds it to the links properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Source may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice.

Receiver links can operate in one of two receive modes: automatic, where the struct will work to ensure that messages are received as soon as they are available; and retrieve-based, where the struct will only "retrieve" a new message when explicitly instructed to.

The receive_mode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

create_sender_link method (AMQP Struct)

Creates a new sender link with the given name on the specified session.

Syntax

fn create_sender_link(&self, session_name : &str, name : &str, target : &str) -> Result<(), IPWorksMQError>

Remarks

This method creates a new sender link with the given Name on the session specified by SessionName and adds it to the links properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Target may be set to specify the address of the node at the remote host which should act as the receiver. This may not be necessary in all environments, in which case an empty string will suffice.

The on_link_ready_to_send event will fire when a newly-created sender link is ready to send.

Sender links are created using the Mixed settle mode by default, letting the value of the message_settled property control whether each message is settled (the default) or unsettled when it is sent. The DefaultSenderSettleMode configuration setting can be used to control the settle mode that new sender links are created with. Refer to send_message for more information on message settlement in general.

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.

create_session method (AMQP Struct)

Creates a new session with the given name.

Syntax

fn create_session(&self, name : &str) -> Result<(), IPWorksMQError>

Remarks

This method creates a new session with the given Name and adds it to the sessions properties. If a session with the given Name already exists, an error will be thrown.

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.

disconnect method (AMQP Struct)

This method disconnects from the remote host.

Syntax

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

Remarks

This method disconnects from the remote host.

do_events method (AMQP Struct)

This method processes events from the internal message queue.

Syntax

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

Remarks

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

interrupt method (AMQP Struct)

This method interrupts the current action.

Syntax

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

Remarks

This method interrupts the current action. If you use send_file to upload a file, the struct will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

reset method (AMQP Struct)

This method will reset the struct.

Syntax

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

Remarks

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

reset_message method (AMQP Struct)

Resets the Message properties.

Syntax

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

Remarks

This method resets the message property.

retrieve_message method (AMQP Struct)

Retrieves a single message over the specified receiver link.

Syntax

fn retrieve_message(&self, link_name : &str) -> Result<(), IPWorksMQError>

Remarks

When retrieve_message is called, the struct will supply the sender with a single credit and then block until a message is received (if the retrieve_timeout property is set to zero).

If retrieve_timeout is non-zero, the struct will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the LinkDeliveryCount property rather than by sending a message, then the struct will throw an error indicating a timeout.

LinkName specifies the receiver link which should retrieve a message; if there is no such link, if the specified link is not a receiver link, or if the specified receiver link is not operating in rmSyncGet (1) mode, an error is thrown.

Refer to receive_mode and retrieve_timeout for more information.

send_message method (AMQP Struct)

Sends a message on the specified link.

Syntax

fn send_message(&self, link_name : &str) -> Result<(), IPWorksMQError>

Remarks

This method sends a message on the link specified by LinkName.

The message property holds an AMQPMessage object whose properties are used to construct the message to send. At minimum, specify a and a . amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName");

Message Settlement

• Settled - All messages will be sent in a settled state.
• Unsettled - All messages will be sent in an unsettled state.
• Mixed - Messages may be sent either settled or unsettled.

• First - Incoming messages will be settled immediately (and the sender will be notified that the message has been received, if the message was not already settled when sent).
• Second - Incoming messages will be settled after the sender has settled them (and the sender will be notified when a message has been received, if the message was not already settled when sent).

Together, the sender's and receiver's settle modes can form the following delivery guarantees:

It is important to note that the message settlement system has a big caveat: Whichever party opens the link can only request that the other end use a specific settle mode. For example, if the struct opens a sender link, it has control over the sender settle mode it will use, but it can only request that the remote host use a specific receiver settle mode; so if the struct requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).

The struct currently only ever requests (and itself only supports) the First receiver settle mode since no other AMQP implementations appear to support the Second receiver settle mode at this time.

The struct requests (and uses) the Mixed sender settle mode by default, but supports all of the sender settle modes (the default can be changed using the DefaultSenderSettleMode configuration setting). Sender links created with the Mixed sender use the value of the message_settled property to determine whether to send messages as settled or unsettled.

Sending Composite Data

Composite Data JSON Schema

The struct uses JSON with a well-defined schema to represent composite data. The composite data JSON schema consists almost entirely of "type-value" objects, which hold an AMQP typename and a value. The syntax for a type-value object is:

{
  "type": "typename",
  "value": value
}

The following table provides a complete list of valid typenames, and describes how the associated values should be represented:

Arrays, Lists, and Maps

The AMQP data model defines three data structure types: array, list, and map. In the composite data JSON schema, their value is always a JSON array that contains zero or more type-value objects. Data structure types may be nested arbitrarily to any depth.

Note that the array and map data structures each have restrictions on their content:

• The elements in an array must all be of the same type (e.g., their typenames must match).
• The elements in a map represent keys (odd-numbered elements) and values (even-numbered elements). There must be an even number of elements (or none), and the values of the "key" elements must be unique.

{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "value1" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

Described Types

As noted above, AMQP's data model includes the idea of "described types", which is simply a normal AMQP type annotated by a descriptor. The descriptor defines what the data it is associated with represents as a whole.

In the composite data JSON schema, a described type object is just a normal type-value object with an extra "descriptor" property on it (and the "descriptor" property's value is itself a normal type-value object). The syntax for a described type object is:

{
  "descriptor": { "type": "typename", "value": value },
  "type": "typename",
  "value": value
}

Described type objects can be used anywhere that normal type-value objects can be, except as the value of the "descriptor" property for another described type object, which must be a normal type-value object.

Note that, according to the AMQP specification, the type of the descriptor itself ulong or symbol, but the struct does not enforce this.

Abbreviated Value Syntax

For brevity, it is possible to abbreviate both normal type-value objects and described type objects when their value type is null, boolean, or string.

For normal type-value objects, instead of using the standard syntax (e.g., { "type": "string", "value": "Hello, world!" }), just use the raw value itself (e.g., "Hello, world!"). Keep in mind that the abbreviated value must still be valid JSON; notably, strings must still be surrounded by quotes (e.g., "value", not value).

The abbreviated syntax for a described type object is a bit different; the "descriptor" property still needs to be associated with the value using a JSON object. To abbreviate a described type object, just exclude the "type" property, like so:

{
  "descriptor": { "type": "typename", "value": value },
  "value": value
}

The abbreviated value syntax can be used anywhere that an unabbreviated type-value object or described type object would normally be used.

The struct defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the SimplifiedJSONFormat configuration setting.

Composite Data JSON Example

{
  "descriptor": { "type": "symbol", "value": "nsoftware:compositeDataExample" },
  "type": "list",
  "value": [
    "Shorthand string value",
    null,
    true,
    { "type": "uuid", "value": "12345678-0000-1000-8000-00805F9B34FB" },
    {
      "type": "array",
      "value": [
        { "type": "uint", "value": 23 },
        { "type": "uint", "value": 52 },
        { "type": "uint", "value": 153325 }
      ]
    },
    {
      "type": "map",
      "value": [
        { "type": "symbol", "value": "name" },
        "Freezer temperature",
        { "type": "symbol", "value": "unit" },
        "Fahrenheit",
        { "type": "symbol", "value": "value" },
        { "type": "int", "value": -2 }
      ]
    },
    {
      "descriptor": { "type": "symbol", "value": "nsoftware:utf8Bytes" },
      "type": "binary",
      "value": "48656C6C6F2C20776F726C6421"
    }
  ]
}

on_connected event (AMQP Struct)

Fired immediately after a connection completes (or fails).

Syntax

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

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

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

Remarks

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

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

Please refer to the Error Codes section for more information.

on_connection_status event (AMQP Struct)

Fired to indicate changes in the connection state.

Syntax

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

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

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

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

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

on_disconnected event (AMQP Struct)

Fired when a connection is closed.

Syntax

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

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

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

Remarks

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

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

Please refer to the Error Codes section for more information.

on_error event (AMQP Struct)

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

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

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

on_link_ready_to_send event (AMQP Struct)

Fires when a sender link is ready to send messages.

Syntax

// AMQPLinkReadyToSendEventArgs carries the AMQP LinkReadyToSend event's parameters.
pub struct AMQPLinkReadyToSendEventArgs {
  fn link_name(&self) -> &String
  fn link_index(&self) -> i32
}

// AMQPLinkReadyToSendEvent defines the signature of the AMQP LinkReadyToSend event's handler function.
pub trait AMQPLinkReadyToSendEvent {
  fn on_link_ready_to_send(&self, sender : AMQP, e : &mut AMQPLinkReadyToSendEventArgs);
}

impl <'a> AMQP<'a> {
  pub fn on_link_ready_to_send(&self) -> &'a dyn AMQPLinkReadyToSendEvent;
  pub fn set_on_link_ready_to_send(&mut self, value : &'a dyn AMQPLinkReadyToSendEvent);
  ...
}

Remarks

This event fires when a sender link is ready to send messages.

LinkName is the name of the sender link.

LinkIndex is the index of the sender link in the links properties.

on_log event (AMQP Struct)

Fires once for each log message.

Syntax

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

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

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

Remarks

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

LogLevel indicates the level of the Message. Possible values are:

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

• Info: General information about the struct.
• Session: Session status messages.
• Frame: Frame status messages.

on_message_in event (AMQP Struct)

Fires when the struct receives a message.

Syntax

// AMQPMessageInEventArgs carries the AMQP MessageIn event's parameters.
pub struct AMQPMessageInEventArgs {
  fn session_name(&self) -> &String
  fn session_index(&self) -> i32
  fn link_name(&self) -> &String
  fn link_index(&self) -> i32
  fn message_id(&self) -> &String
  fn state(&self) -> i32
  fn set_state(&self, value : i32)
}

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

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

Remarks

This event fires whenever the struct receives a message. The message itself is automatically stored in the received_message property.

Specifying a Delivery Outcome

• 0: Accepted - The message has been processed successfully.
• 1: Rejected - The message failed to process successfully. Includes an error describing why.
• 2: Released - The message has not been (and will not be) processed.
• 3: Modified - Same as "Released", but with additional metadata for the sender.

When State is set to Rejected (1), the struct will include error metadata when it informs the sender of the outcome. Set the RejectErrorCondition and RejectErrorDescription configuration settings before the event handler finishes to specify this error information.

When State is set to Modified (3), the struct can include additional metadata when it informs the sender of the outcome. Set zero or more of the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings before the event handler finishes to specify this additional metadata.

Other Parameters

SessionIndex is the index of the session in the sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

on_message_out event (AMQP Struct)

Fires when the struct sends a message.

Syntax

// AMQPMessageOutEventArgs carries the AMQP MessageOut event's parameters.
pub struct AMQPMessageOutEventArgs {
  fn session_name(&self) -> &String
  fn session_index(&self) -> i32
  fn link_name(&self) -> &String
  fn link_index(&self) -> i32
  fn message_id(&self) -> &String
}

// AMQPMessageOutEvent defines the signature of the AMQP MessageOut event's handler function.
pub trait AMQPMessageOutEvent {
  fn on_message_out(&self, sender : AMQP, e : &mut AMQPMessageOutEventArgs);
}

impl <'a> AMQP<'a> {
  pub fn on_message_out(&self) -> &'a dyn AMQPMessageOutEvent;
  pub fn set_on_message_out(&mut self, value : &'a dyn AMQPMessageOutEvent);
  ...
}

Remarks

This event fires whenever the struct sends a message.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

on_message_outcome event (AMQP Struct)

Fires when a message's outcome is available.

Syntax

// AMQPMessageOutcomeEventArgs carries the AMQP MessageOutcome event's parameters.
pub struct AMQPMessageOutcomeEventArgs {
  fn session_name(&self) -> &String
  fn session_index(&self) -> i32
  fn link_name(&self) -> &String
  fn link_index(&self) -> i32
  fn message_id(&self) -> &String
  fn direction(&self) -> i32
  fn state(&self) -> i32
}

// AMQPMessageOutcomeEvent defines the signature of the AMQP MessageOutcome event's handler function.
pub trait AMQPMessageOutcomeEvent {
  fn on_message_outcome(&self, sender : AMQP, e : &mut AMQPMessageOutcomeEventArgs);
}

impl <'a> AMQP<'a> {
  pub fn on_message_outcome(&self) -> &'a dyn AMQPMessageOutcomeEvent;
  pub fn set_on_message_outcome(&mut self, value : &'a dyn AMQPMessageOutcomeEvent);
  ...
}

Remarks

This event fires whenever the outcome for a message (incoming or outgoing) is available.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

Direction indicates whether this outcome was sent (0) or received (1).

State indicates the actual message outcome. Possible values are:

• 0: Accepted - The message has been processed successfully.
• 1: Rejected - The message failed to process successfully. Includes an error describing why.
• 2: Released - The message has not been (and will not be) processed.
• 3: Modified - Same as "Released", but with additional metadata for the sender.

When State is Rejected (1), the RejectErrorCondition and RejectErrorDescription configuration settings can be queried before the event handler finishes to retrieve the error information.

When State is Modified (3), the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings can be queried before the event handler finishes to retrieve the additional metadata.

on_ssl_server_authentication event (AMQP Struct)

Fired after the server presents its certificate to the client.

Syntax

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

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

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

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

Fired when secure connection progress messages are available.

Syntax

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

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

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

Remarks

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

Config Settings (AMQP Struct)

AMQP Config Settings

{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "test" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

TCPClient Config Settings

SSL Config Settings

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