AMQP Control

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Syntax

AMQP

Remarks

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

Connecting

The control implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the ContainerId property and call the ConnectTo 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 CreateSession method. The control 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 control 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 control is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the control cannot accept any link requests made by other peers).

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

Creating Sender Links

The LinkReadyToSend 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 MessageValue and MessageValueType properties must be set. All other properties are optional, though specifying a unique value for MessageId is recommended. (If the GenerateMessageId configuration setting is enabled, the control will generate one automatically when the message is sent.)

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

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

Refer to SendMessage, MessageOut, and MessageOutcome 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 ResetMessage method can be used to reset the Message property's properties to their default values.

Sending Composite AMQP Data

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

Creating Receiver Links

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

After ensuring that ReceiveMode is set as desired, call CreateReceiverLink, 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 control will attempt to "retrieve" a message each time the RetrieveMessage method is called (optionally timing out after a time, if RetrieveTimeout is non-zero). When calling RetrieveMessage, 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 control to fire the MessageIn event and update the ReceivedMessage property's properties.

When the MessageIn event fires, its State event parameter can be used to specify the outcome of the message, which the control will then transmit back to the sender (as well as self-report by firing the MessageOutcome event). Refer to MessageIn 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");

Property List

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

Method List

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

Event List

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

Config Settings

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

AuthScheme Property (AMQP Control)

The authentication scheme to use when connecting.

Syntax

amqpcontrol.AuthScheme[=integer]

Possible Values

smNone(0), 
smSASLAnonymous(1), 
smSASLPlain(2), 
smSASLExternal(3)

Default Value

2

Remarks

This property controls what authentication scheme the control should use when connecting to the remote host.

Valid values are:

• smNone (0)
• smSASLAnonymous (1)
• smSASLPlain (2) - Default
• smSASLExternal (3)

This property is not available at design time.

Data Type

Integer

Connected Property (AMQP Control)

This property indicates whether the control is connected.

Syntax

amqpcontrol.Connected

Default Value

False

Remarks

This property indicates whether the control is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

ContainerId Property (AMQP Control)

The container Id the control should advertise when connecting.

Syntax

amqpcontrol.ContainerId[=string]

Default Value

""

Remarks

This property specifies the container Id that the control 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 control 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.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (AMQP Control)

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

Syntax

amqpcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (AMQP Control)

The type of firewall to connect through.

Syntax

amqpcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (AMQP Control)

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

Syntax

amqpcontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost 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 control fails with an error.

Data Type

String

FirewallPassword Property (AMQP Control)

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

Syntax

amqpcontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AMQP Control)

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

Syntax

amqpcontrol.FirewallPort[=integer]

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (AMQP Control)

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

Syntax

amqpcontrol.FirewallUser[=string]

Default Value

""

Remarks

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

Data Type

String

IdleTimeout Property (AMQP Control)

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

Syntax

amqpcontrol.IdleTimeout[=integer]

Default Value

0

Remarks

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

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

Note: The idle timeout cannot be changed while connected.

This property is not available at design time.

Data Type

Integer

IncomingMessageCount Property (AMQP Control)

The number of records in the IncomingMessage arrays.

Syntax

amqpcontrol.IncomingMessageCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• IncomingMessageAbsoluteExpiryTime
• IncomingMessageContentEncoding
• IncomingMessageContentType
• IncomingMessageCorrelationId
• IncomingMessageCreationTime
• IncomingMessageDeliveryCount
• IncomingMessageDurable
• IncomingMessageFirstAcquirer
• IncomingMessageGroupId
• IncomingMessageGroupSequence
• IncomingMessageId
• IncomingMessageLinkName
• IncomingMessagePriority
• IncomingMessageReplyTo
• IncomingMessageReplyToGroupId
• IncomingMessageSettled
• IncomingMessageSubject
• IncomingMessageTo
• IncomingMessageTTL
• IncomingMessageUserId
• IncomingMessageValue
• IncomingMessageValueType

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

This property is read-only and not available at design time.

Data Type

Integer

IncomingMessageAbsoluteExpiryTime Property (AMQP Control)

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

Syntax

amqpcontrol.IncomingMessageAbsoluteExpiryTime(IncomingMessageIndex)

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 and not available at design time.

Data Type

Long64

IncomingMessageContentEncoding Property (AMQP Control)

The content encoding of this message's data.

Syntax

amqpcontrol.IncomingMessageContentEncoding(IncomingMessageIndex)

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 IncomingMessageValueType is not set to mvtBinary (16).

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 and not available at design time.

Data Type

String

IncomingMessageContentType Property (AMQP Control)

The content type of this message's data.

Syntax

amqpcontrol.IncomingMessageContentType(IncomingMessageIndex)

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 IncomingMessageValueType is not set to mvtBinary (16).

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 and not available at design time.

Data Type

String

IncomingMessageCorrelationId Property (AMQP Control)

The correlation Id of this message.

Syntax

amqpcontrol.IncomingMessageCorrelationId(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageCreationTime Property (AMQP Control)

The creation time of this message.

Syntax

amqpcontrol.IncomingMessageCreationTime(IncomingMessageIndex)

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 and not available at design time.

Data Type

Long64

IncomingMessageDeliveryCount Property (AMQP Control)

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

Syntax

amqpcontrol.IncomingMessageDeliveryCount(IncomingMessageIndex)

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 and not available at design time.

Data Type

Long64

IncomingMessageDurable Property (AMQP Control)

Whether this message is durable.

Syntax

amqpcontrol.IncomingMessageDurable(IncomingMessageIndex)

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 and not available at design time.

Data Type

Boolean

IncomingMessageFirstAcquirer Property (AMQP Control)

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

Syntax

amqpcontrol.IncomingMessageFirstAcquirer(IncomingMessageIndex)

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 and not available at design time.

Data Type

Boolean

IncomingMessageGroupId Property (AMQP Control)

The Id of the group this message belongs to.

Syntax

amqpcontrol.IncomingMessageGroupId(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageGroupSequence Property (AMQP Control)

The position of this message within its group.

Syntax

amqpcontrol.IncomingMessageGroupSequence(IncomingMessageIndex)

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 and not available at design time.

Data Type

Long64

IncomingMessageLinkName Property (AMQP Control)

The name of the link this message is associated with.

Syntax

amqpcontrol.IncomingMessageLinkName(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageId Property (AMQP Control)

The unique Id of this message.

Syntax

amqpcontrol.IncomingMessageId(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessagePriority Property (AMQP Control)

The priority of this message.

Syntax

amqpcontrol.IncomingMessagePriority(IncomingMessageIndex)

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 and not available at design time.

Data Type

Integer

IncomingMessageReplyTo Property (AMQP Control)

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

Syntax

amqpcontrol.IncomingMessageReplyTo(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageReplyToGroupId Property (AMQP Control)

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

Syntax

amqpcontrol.IncomingMessageReplyToGroupId(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageSettled Property (AMQP Control)

Whether this message is settled.

Syntax

amqpcontrol.IncomingMessageSettled(IncomingMessageIndex)

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 and not available at design time.

Data Type

Boolean

IncomingMessageSubject Property (AMQP Control)

The subject of this message.

Syntax

amqpcontrol.IncomingMessageSubject(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageTo Property (AMQP Control)

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

Syntax

amqpcontrol.IncomingMessageTo(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageTTL Property (AMQP Control)

The time-to-live value for this message.

Syntax

amqpcontrol.IncomingMessageTTL(IncomingMessageIndex)

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 and not available at design time.

Data Type

Long64

IncomingMessageUserId Property (AMQP Control)

The identity of the user responsible for producing this message.

Syntax

amqpcontrol.IncomingMessageUserId(IncomingMessageIndex)

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 and not available at design time.

Data Type

String

IncomingMessageValue Property (AMQP Control)

This message's value.

Syntax

amqpcontrol.IncomingMessageValue(IncomingMessageIndex)

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The IncomingMessageValueType 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 and not available at design time.

Data Type

String

IncomingMessageValueType Property (AMQP Control)

This message's value data type.

Syntax

amqpcontrol.IncomingMessageValueType(IncomingMessageIndex)

Possible Values

mvtNull(0), 
mvtBoolean(1), 
mvtUbyte(2), 
mvtUshort(3), 
mvtUint(4), 
mvtUlong(5), 
mvtByte(6), 
mvtShort(7), 
mvtInt(8), 
mvtLong(9), 
mvtFloat(10), 
mvtDouble(11), 
mvtDecimal(12), 
mvtChar(13), 
mvtTimestamp(14), 
mvtUuid(15), 
mvtBinary(16), 
mvtString(17), 
mvtSymbol(18), 
mvtJson(19)

Default Value

0

Remarks

This message's value data type.

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

The table below shows the possible value types, their descriptions, and how to format the data assigned to IncomingMessageValue. 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 and not available at design time.

Data Type

Integer

LinkCount Property (AMQP Control)

The number of records in the Link arrays.

Syntax

amqpcontrol.LinkCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• LinkAvailable
• LinkChannelName
• LinkCredit
• LinkDeliveryCount
• LinkName
• LinkReadyToSend
• LinkReceiveMode
• LinkRole

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

This property is read-only and not available at design time.

Data Type

Integer

LinkAvailable Property (AMQP Control)

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

Syntax

amqpcontrol.LinkAvailable(LinkIndex)

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 and not available at design time.

Data Type

Long64

LinkChannelName Property (AMQP Control)

The channel name this link is using.

Syntax

amqpcontrol.LinkChannelName(LinkIndex)

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 and not available at design time.

Data Type

String

LinkCredit Property (AMQP Control)

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

Syntax

amqpcontrol.LinkCredit(LinkIndex)

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 and not available at design time.

Data Type

Long64

LinkDeliveryCount Property (AMQP Control)

The current delivery count value for this link.

Syntax

amqpcontrol.LinkDeliveryCount(LinkIndex)

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 and not available at design time.

Data Type

Long64

LinkName Property (AMQP Control)

This link's name.

Syntax

amqpcontrol.LinkName(LinkIndex)

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 and not available at design time.

Data Type

String

LinkReadyToSend Property (AMQP Control)

Whether this link is ready to send a message.

Syntax

amqpcontrol.LinkReadyToSend(LinkIndex)

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 LinkRole 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 and not available at design time.

Data Type

Boolean

LinkReceiveMode Property (AMQP Control)

The receive mode this link is operating in.

Syntax

amqpcontrol.LinkReceiveMode(LinkIndex)

Possible Values

lrmAutomatic(0), 
lrmRetrieve(1)

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 ReceiveMode 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 and not available at design time.

Data Type

Integer

LinkRole Property (AMQP Control)

The control's role on this link.

Syntax

amqpcontrol.LinkRole(LinkIndex)

Possible Values

lrSender(0), 
lrReceiver(1)

Default Value

0

Remarks

The control's role on this link.

This property reflects which role the control 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 and not available at design time.

Data Type

Integer

LocalHost Property (AMQP Control)

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

Syntax

amqpcontrol.LocalHost[=string]

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 control initiate connections (or accept in the case of server controls) 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 control is connected, the LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (AMQP Control)

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

Syntax

amqpcontrol.LocalPort[=integer]

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the control 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 LocalPort property after the connection is established.

LocalPort 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

Integer

MessageAbsoluteExpiryTime Property (AMQP Control)

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

Syntax

amqpcontrol.MessageAbsoluteExpiryTime[=long64]

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 not available at design time.

Data Type

Long64

MessageContentEncoding Property (AMQP Control)

The content encoding of this message's data.

Syntax

amqpcontrol.MessageContentEncoding[=string]

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 MessageValueType is not set to mvtBinary (16).

This property is not available at design time.

Data Type

String

MessageContentType Property (AMQP Control)

The content type of this message's data.

Syntax

amqpcontrol.MessageContentType[=string]

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 MessageValueType is not set to mvtBinary (16).

This property is not available at design time.

Data Type

String

MessageCorrelationId Property (AMQP Control)

The correlation Id of this message.

Syntax

amqpcontrol.MessageCorrelationId[=string]

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 not available at design time.

Data Type

String

MessageCreationTime Property (AMQP Control)

The creation time of this message.

Syntax

amqpcontrol.MessageCreationTime[=long64]

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 not available at design time.

Data Type

Long64

MessageDeliveryCount Property (AMQP Control)

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

Syntax

amqpcontrol.MessageDeliveryCount[=long64]

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 not available at design time.

Data Type

Long64

MessageDurable Property (AMQP Control)

Whether this message is durable.

Syntax

amqpcontrol.MessageDurable[=boolean]

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 not available at design time.

Data Type

Boolean

MessageFirstAcquirer Property (AMQP Control)

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

Syntax

amqpcontrol.MessageFirstAcquirer[=boolean]

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 not available at design time.

Data Type

Boolean

MessageGroupId Property (AMQP Control)

The Id of the group this message belongs to.

Syntax

amqpcontrol.MessageGroupId[=string]

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 not available at design time.

Data Type

String

MessageGroupSequence Property (AMQP Control)

The position of this message within its group.

Syntax

amqpcontrol.MessageGroupSequence[=long64]

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 not available at design time.

Data Type

Long64

MessageLinkName Property (AMQP Control)

The name of the link this message is associated with.

Syntax

amqpcontrol.MessageLinkName

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 and not available at design time.

Data Type

String

MessageId Property (AMQP Control)

The unique Id of this message.

Syntax

amqpcontrol.MessageId[=string]

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 not available at design time.

Data Type

String

MessagePriority Property (AMQP Control)

The priority of this message.

Syntax

amqpcontrol.MessagePriority[=integer]

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 not available at design time.

Data Type

Integer

MessageReplyTo Property (AMQP Control)

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

Syntax

amqpcontrol.MessageReplyTo[=string]

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 not available at design time.

Data Type

String

MessageReplyToGroupId Property (AMQP Control)

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

Syntax

amqpcontrol.MessageReplyToGroupId[=string]

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 not available at design time.

Data Type

String

MessageSettled Property (AMQP Control)

Whether this message is settled.

Syntax

amqpcontrol.MessageSettled[=boolean]

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 not available at design time.

Data Type

Boolean

MessageSubject Property (AMQP Control)

The subject of this message.

Syntax

amqpcontrol.MessageSubject[=string]

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 not available at design time.

Data Type

String

MessageTo Property (AMQP Control)

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

Syntax

amqpcontrol.MessageTo[=string]

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 not available at design time.

Data Type

String

MessageTTL Property (AMQP Control)

The time-to-live value for this message.

Syntax

amqpcontrol.MessageTTL[=long64]

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 not available at design time.

Data Type

Long64

MessageUserId Property (AMQP Control)

The identity of the user responsible for producing this message.

Syntax

amqpcontrol.MessageUserId[=string]

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 not available at design time.

Data Type

String

MessageValue Property (AMQP Control)

This message's value.

Syntax

amqpcontrol.MessageValue[=string]

Default Value

""

Remarks

This message's value.

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

This property is not available at design time.

Data Type

String

MessageValueType Property (AMQP Control)

This message's value data type.

Syntax

amqpcontrol.MessageValueType[=integer]

Possible Values

mvtNull(0), 
mvtBoolean(1), 
mvtUbyte(2), 
mvtUshort(3), 
mvtUint(4), 
mvtUlong(5), 
mvtByte(6), 
mvtShort(7), 
mvtInt(8), 
mvtLong(9), 
mvtFloat(10), 
mvtDouble(11), 
mvtDecimal(12), 
mvtChar(13), 
mvtTimestamp(14), 
mvtUuid(15), 
mvtBinary(16), 
mvtString(17), 
mvtSymbol(18), 
mvtJson(19)

Default Value

0

Remarks

This message's value data type.

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

The table below shows the possible value types, their descriptions, and how to format the data assigned to MessageValue. 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 not available at design time.

Data Type

Integer

OutgoingMessageCount Property (AMQP Control)

The number of records in the OutgoingMessage arrays.

Syntax

amqpcontrol.OutgoingMessageCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• OutgoingMessageAbsoluteExpiryTime
• OutgoingMessageContentEncoding
• OutgoingMessageContentType
• OutgoingMessageCorrelationId
• OutgoingMessageCreationTime
• OutgoingMessageDeliveryCount
• OutgoingMessageDurable
• OutgoingMessageFirstAcquirer
• OutgoingMessageGroupId
• OutgoingMessageGroupSequence
• OutgoingMessageId
• OutgoingMessageLinkName
• OutgoingMessagePriority
• OutgoingMessageReplyTo
• OutgoingMessageReplyToGroupId
• OutgoingMessageSettled
• OutgoingMessageSubject
• OutgoingMessageTo
• OutgoingMessageTTL
• OutgoingMessageUserId
• OutgoingMessageValue
• OutgoingMessageValueType

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

This property is read-only and not available at design time.

Data Type

Integer

OutgoingMessageAbsoluteExpiryTime Property (AMQP Control)

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

Syntax

amqpcontrol.OutgoingMessageAbsoluteExpiryTime(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Long64

OutgoingMessageContentEncoding Property (AMQP Control)

The content encoding of this message's data.

Syntax

amqpcontrol.OutgoingMessageContentEncoding(OutgoingMessageIndex)

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 OutgoingMessageValueType is not set to mvtBinary (16).

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 and not available at design time.

Data Type

String

OutgoingMessageContentType Property (AMQP Control)

The content type of this message's data.

Syntax

amqpcontrol.OutgoingMessageContentType(OutgoingMessageIndex)

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 OutgoingMessageValueType is not set to mvtBinary (16).

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 and not available at design time.

Data Type

String

OutgoingMessageCorrelationId Property (AMQP Control)

The correlation Id of this message.

Syntax

amqpcontrol.OutgoingMessageCorrelationId(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageCreationTime Property (AMQP Control)

The creation time of this message.

Syntax

amqpcontrol.OutgoingMessageCreationTime(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Long64

OutgoingMessageDeliveryCount Property (AMQP Control)

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

Syntax

amqpcontrol.OutgoingMessageDeliveryCount(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Long64

OutgoingMessageDurable Property (AMQP Control)

Whether this message is durable.

Syntax

amqpcontrol.OutgoingMessageDurable(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Boolean

OutgoingMessageFirstAcquirer Property (AMQP Control)

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

Syntax

amqpcontrol.OutgoingMessageFirstAcquirer(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Boolean

OutgoingMessageGroupId Property (AMQP Control)

The Id of the group this message belongs to.

Syntax

amqpcontrol.OutgoingMessageGroupId(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageGroupSequence Property (AMQP Control)

The position of this message within its group.

Syntax

amqpcontrol.OutgoingMessageGroupSequence(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Long64

OutgoingMessageLinkName Property (AMQP Control)

The name of the link this message is associated with.

Syntax

amqpcontrol.OutgoingMessageLinkName(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageId Property (AMQP Control)

The unique Id of this message.

Syntax

amqpcontrol.OutgoingMessageId(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessagePriority Property (AMQP Control)

The priority of this message.

Syntax

amqpcontrol.OutgoingMessagePriority(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Integer

OutgoingMessageReplyTo Property (AMQP Control)

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

Syntax

amqpcontrol.OutgoingMessageReplyTo(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageReplyToGroupId Property (AMQP Control)

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

Syntax

amqpcontrol.OutgoingMessageReplyToGroupId(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageSettled Property (AMQP Control)

Whether this message is settled.

Syntax

amqpcontrol.OutgoingMessageSettled(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Boolean

OutgoingMessageSubject Property (AMQP Control)

The subject of this message.

Syntax

amqpcontrol.OutgoingMessageSubject(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageTo Property (AMQP Control)

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

Syntax

amqpcontrol.OutgoingMessageTo(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageTTL Property (AMQP Control)

The time-to-live value for this message.

Syntax

amqpcontrol.OutgoingMessageTTL(OutgoingMessageIndex)

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 and not available at design time.

Data Type

Long64

OutgoingMessageUserId Property (AMQP Control)

The identity of the user responsible for producing this message.

Syntax

amqpcontrol.OutgoingMessageUserId(OutgoingMessageIndex)

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 and not available at design time.

Data Type

String

OutgoingMessageValue Property (AMQP Control)

This message's value.

Syntax

amqpcontrol.OutgoingMessageValue(OutgoingMessageIndex)

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The OutgoingMessageValueType 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 and not available at design time.

Data Type

String

OutgoingMessageValueType Property (AMQP Control)

This message's value data type.

Syntax

amqpcontrol.OutgoingMessageValueType(OutgoingMessageIndex)

Possible Values

mvtNull(0), 
mvtBoolean(1), 
mvtUbyte(2), 
mvtUshort(3), 
mvtUint(4), 
mvtUlong(5), 
mvtByte(6), 
mvtShort(7), 
mvtInt(8), 
mvtLong(9), 
mvtFloat(10), 
mvtDouble(11), 
mvtDecimal(12), 
mvtChar(13), 
mvtTimestamp(14), 
mvtUuid(15), 
mvtBinary(16), 
mvtString(17), 
mvtSymbol(18), 
mvtJson(19)

Default Value

0

Remarks

This message's value data type.

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

The table below shows the possible value types, their descriptions, and how to format the data assigned to OutgoingMessageValue. 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 and not available at design time.

Data Type

Integer

Password Property (AMQP Control)

A password to use for SASL authentication.

Syntax

amqpcontrol.Password[=string]

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

This property is not available at design time.

Data Type

String

ReadyToSend Property (AMQP Control)

Indicates whether the control is ready to send data.

Syntax

amqpcontrol.ReadyToSend

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 SendMessage fails due to a WOULDBLOCK condition.

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

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

This property is read-only and not available at design time.

Data Type

Boolean

ReceivedMessageAbsoluteExpiryTime Property (AMQP Control)

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

Syntax

amqpcontrol.ReceivedMessageAbsoluteExpiryTime

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 and not available at design time.

Data Type

Long64

ReceivedMessageContentEncoding Property (AMQP Control)

The content encoding of this message's data.

Syntax

amqpcontrol.ReceivedMessageContentEncoding

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 ReceivedMessageValueType is not set to mvtBinary (16).

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageContentType Property (AMQP Control)

The content type of this message's data.

Syntax

amqpcontrol.ReceivedMessageContentType

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 ReceivedMessageValueType is not set to mvtBinary (16).

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageCorrelationId Property (AMQP Control)

The correlation Id of this message.

Syntax

amqpcontrol.ReceivedMessageCorrelationId

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 and not available at design time.

Data Type

String

ReceivedMessageCreationTime Property (AMQP Control)

The creation time of this message.

Syntax

amqpcontrol.ReceivedMessageCreationTime

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 and not available at design time.

Data Type

Long64

ReceivedMessageDeliveryCount Property (AMQP Control)

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

Syntax

amqpcontrol.ReceivedMessageDeliveryCount

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 and not available at design time.

Data Type

Long64

ReceivedMessageDurable Property (AMQP Control)

Whether this message is durable.

Syntax

amqpcontrol.ReceivedMessageDurable

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 and not available at design time.

Data Type

Boolean

ReceivedMessageFirstAcquirer Property (AMQP Control)

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

Syntax

amqpcontrol.ReceivedMessageFirstAcquirer

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 and not available at design time.

Data Type

Boolean

ReceivedMessageGroupId Property (AMQP Control)

The Id of the group this message belongs to.

Syntax

amqpcontrol.ReceivedMessageGroupId

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 and not available at design time.

Data Type

String

ReceivedMessageGroupSequence Property (AMQP Control)

The position of this message within its group.

Syntax

amqpcontrol.ReceivedMessageGroupSequence

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 and not available at design time.

Data Type

Long64

ReceivedMessageLinkName Property (AMQP Control)

The name of the link this message is associated with.

Syntax

amqpcontrol.ReceivedMessageLinkName

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 and not available at design time.

Data Type

String

ReceivedMessageId Property (AMQP Control)

The unique Id of this message.

Syntax

amqpcontrol.ReceivedMessageId

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 and not available at design time.

Data Type

String

ReceivedMessagePriority Property (AMQP Control)

The priority of this message.

Syntax

amqpcontrol.ReceivedMessagePriority

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 and not available at design time.

Data Type

Integer

ReceivedMessageReplyTo Property (AMQP Control)

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

Syntax

amqpcontrol.ReceivedMessageReplyTo

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 and not available at design time.

Data Type

String

ReceivedMessageReplyToGroupId Property (AMQP Control)

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

Syntax

amqpcontrol.ReceivedMessageReplyToGroupId

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 and not available at design time.

Data Type

String

ReceivedMessageSettled Property (AMQP Control)

Whether this message is settled.

Syntax

amqpcontrol.ReceivedMessageSettled

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 and not available at design time.

Data Type

Boolean

ReceivedMessageSubject Property (AMQP Control)

The subject of this message.

Syntax

amqpcontrol.ReceivedMessageSubject

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 and not available at design time.

Data Type

String

ReceivedMessageTo Property (AMQP Control)

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

Syntax

amqpcontrol.ReceivedMessageTo

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 and not available at design time.

Data Type

String

ReceivedMessageTTL Property (AMQP Control)

The time-to-live value for this message.

Syntax

amqpcontrol.ReceivedMessageTTL

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 and not available at design time.

Data Type

Long64

ReceivedMessageUserId Property (AMQP Control)

The identity of the user responsible for producing this message.

Syntax

amqpcontrol.ReceivedMessageUserId

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 and not available at design time.

Data Type

String

ReceivedMessageValue Property (AMQP Control)

This message's value.

Syntax

amqpcontrol.ReceivedMessageValue

Default Value

""

Remarks

This message's value.

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

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageValueType Property (AMQP Control)

This message's value data type.

Syntax

amqpcontrol.ReceivedMessageValueType

Possible Values

mvtNull(0), 
mvtBoolean(1), 
mvtUbyte(2), 
mvtUshort(3), 
mvtUint(4), 
mvtUlong(5), 
mvtByte(6), 
mvtShort(7), 
mvtInt(8), 
mvtLong(9), 
mvtFloat(10), 
mvtDouble(11), 
mvtDecimal(12), 
mvtChar(13), 
mvtTimestamp(14), 
mvtUuid(15), 
mvtBinary(16), 
mvtString(17), 
mvtSymbol(18), 
mvtJson(19)

Default Value

0

Remarks

This message's value data type.

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

The table below shows the possible value types, their descriptions, and how to format the data assigned to ReceivedMessageValue. 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 and not available at design time.

Data Type

Integer

ReceiveMode Property (AMQP Control)

Controls what mode new receiver links are created with.

Syntax

amqpcontrol.ReceiveMode[=integer]

Possible Values

rmAutomatic(0), 
rmRetrieve(1)

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 control 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 RetrieveMessage is called, the control will supply the sender with a single credit and then block until a message is received (if the RetrieveTimeout property is set to zero).

If RetrieveTimeout is non-zero, the control 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 control will throw an error indicating a timeout.

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

This property is not available at design time.

Data Type

Integer

RemoteHost Property (AMQP Control)

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

Syntax

amqpcontrol.RemoteHost[=string]

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

RemotePort Property (AMQP Control)

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

Syntax

amqpcontrol.RemotePort[=integer]

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.

This property is not available at design time.

Data Type

Integer

RetrieveTimeout Property (AMQP Control)

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

Syntax

amqpcontrol.RetrieveTimeout[=integer]

Default Value

60

Remarks

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

Refer to RetrieveMessage for more information.

This property is not available at design time.

Data Type

Integer

SessionCount Property (AMQP Control)

The number of records in the Session arrays.

Syntax

amqpcontrol.SessionCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SessionIncomingWindow
• SessionName
• SessionOutgoingWindow

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

This property is read-only and not available at design time.

Data Type

Integer

SessionIncomingWindow Property (AMQP Control)

The incoming window size of this session.

Syntax

amqpcontrol.SessionIncomingWindow(SessionIndex)

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 and not available at design time.

Data Type

Long64

SessionName Property (AMQP Control)

The name of this session.

Syntax

amqpcontrol.SessionName(SessionIndex)

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 and not available at design time.

Data Type

String

SessionOutgoingWindow Property (AMQP Control)

The outgoing window size of this session.

Syntax

amqpcontrol.SessionOutgoingWindow(SessionIndex)

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 and not available at design time.

Data Type

Long64

SSLAcceptServerCertEffectiveDate Property (AMQP Control)

The date on which this certificate becomes valid.

Syntax

amqpcontrol.SSLAcceptServerCertEffectiveDate

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

SSLAcceptServerCertExpirationDate Property (AMQP Control)

The date on which the certificate expires.

Syntax

amqpcontrol.SSLAcceptServerCertExpirationDate

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

SSLAcceptServerCertExtendedKeyUsage Property (AMQP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amqpcontrol.SSLAcceptServerCertExtendedKeyUsage

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

SSLAcceptServerCertFingerprint Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertFingerprint

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

SSLAcceptServerCertFingerprintSHA1 Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertFingerprintSHA1

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

SSLAcceptServerCertFingerprintSHA256 Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertFingerprintSHA256

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

SSLAcceptServerCertIssuer Property (AMQP Control)

The issuer of the certificate.

Syntax

amqpcontrol.SSLAcceptServerCertIssuer

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

SSLAcceptServerCertPrivateKey Property (AMQP Control)

The private key of the certificate (if available).

Syntax

amqpcontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (AMQP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amqpcontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (AMQP Control)

The public key of the certificate.

Syntax

amqpcontrol.SSLAcceptServerCertPublicKey

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

SSLAcceptServerCertPublicKeyAlgorithm Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertPublicKeyAlgorithm

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

SSLAcceptServerCertPublicKeyLength Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertPublicKeyLength

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

Integer

SSLAcceptServerCertSerialNumber Property (AMQP Control)

The serial number of the certificate encoded as a string.

Syntax

amqpcontrol.SSLAcceptServerCertSerialNumber

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

SSLAcceptServerCertSignatureAlgorithm Property (AMQP Control)

The text description of the certificate's signature algorithm.

Syntax

amqpcontrol.SSLAcceptServerCertSignatureAlgorithm

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

SSLAcceptServerCertStore Property (AMQP Control)

The name of the certificate store for the client certificate.

Syntax

amqpcontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertStorePassword[=string]

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

SSLAcceptServerCertStoreType Property (AMQP Control)

The type of certificate store for this certificate.

Syntax

amqpcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (AMQP Control)

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

Syntax

amqpcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (AMQP Control)

The MD5 hash of the certificate.

Syntax

amqpcontrol.SSLAcceptServerCertThumbprintMD5

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

SSLAcceptServerCertThumbprintSHA1 Property (AMQP Control)

The SHA-1 hash of the certificate.

Syntax

amqpcontrol.SSLAcceptServerCertThumbprintSHA1

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

SSLAcceptServerCertThumbprintSHA256 Property (AMQP Control)

The SHA-256 hash of the certificate.

Syntax

amqpcontrol.SSLAcceptServerCertThumbprintSHA256

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

SSLAcceptServerCertUsage Property (AMQP Control)

The text description of UsageFlags .

Syntax

amqpcontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

SSLAcceptServerCertUsageFlags Property (AMQP Control)

The flags that show intended use for the certificate.

Syntax

amqpcontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (AMQP Control)

The certificate's version number.

Syntax

amqpcontrol.SSLAcceptServerCertVersion

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

SSLAcceptServerCertSubject Property (AMQP Control)

The subject of the certificate used for client authentication.

Syntax

amqpcontrol.SSLAcceptServerCertSubject[=string]

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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (AMQP Control)

The certificate (PEM/Base64 encoded).

Syntax

amqpcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (AMQP Control)

The date on which this certificate becomes valid.

Syntax

amqpcontrol.SSLCertEffectiveDate

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

SSLCertExpirationDate Property (AMQP Control)

The date on which the certificate expires.

Syntax

amqpcontrol.SSLCertExpirationDate

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

SSLCertExtendedKeyUsage Property (AMQP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amqpcontrol.SSLCertExtendedKeyUsage

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

SSLCertFingerprint Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertFingerprint

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

SSLCertFingerprintSHA1 Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertFingerprintSHA1

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

SSLCertFingerprintSHA256 Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertFingerprintSHA256

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

SSLCertIssuer Property (AMQP Control)

The issuer of the certificate.

Syntax

amqpcontrol.SSLCertIssuer

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

SSLCertPrivateKey Property (AMQP Control)

The private key of the certificate (if available).

Syntax

amqpcontrol.SSLCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (AMQP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amqpcontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (AMQP Control)

The public key of the certificate.

Syntax

amqpcontrol.SSLCertPublicKey

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

SSLCertPublicKeyAlgorithm Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertPublicKeyAlgorithm

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

SSLCertPublicKeyLength Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertPublicKeyLength

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

Integer

SSLCertSerialNumber Property (AMQP Control)

The serial number of the certificate encoded as a string.

Syntax

amqpcontrol.SSLCertSerialNumber

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

SSLCertSignatureAlgorithm Property (AMQP Control)

The text description of the certificate's signature algorithm.

Syntax

amqpcontrol.SSLCertSignatureAlgorithm

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

SSLCertStore Property (AMQP Control)

The name of the certificate store for the client certificate.

Syntax

amqpcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertStorePassword[=string]

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

SSLCertStoreType Property (AMQP Control)

The type of certificate store for this certificate.

Syntax

amqpcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (AMQP Control)

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

Syntax

amqpcontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (AMQP Control)

The MD5 hash of the certificate.

Syntax

amqpcontrol.SSLCertThumbprintMD5

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

SSLCertThumbprintSHA1 Property (AMQP Control)

The SHA-1 hash of the certificate.

Syntax

amqpcontrol.SSLCertThumbprintSHA1

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

SSLCertThumbprintSHA256 Property (AMQP Control)

The SHA-256 hash of the certificate.

Syntax

amqpcontrol.SSLCertThumbprintSHA256

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

SSLCertUsage Property (AMQP Control)

The text description of UsageFlags .

Syntax

amqpcontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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

SSLCertUsageFlags Property (AMQP Control)

The flags that show intended use for the certificate.

Syntax

amqpcontrol.SSLCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (AMQP Control)

The certificate's version number.

Syntax

amqpcontrol.SSLCertVersion

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

SSLCertSubject Property (AMQP Control)

The subject of the certificate used for client authentication.

Syntax

amqpcontrol.SSLCertSubject[=string]

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=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (AMQP Control)

The certificate (PEM/Base64 encoded).

Syntax

amqpcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (AMQP Control)

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

Syntax

amqpcontrol.SSLEnabled[=boolean]

Default Value

False

Remarks

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

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode 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.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (AMQP Control)

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

Syntax

amqpcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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 control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (AMQP Control)

The date on which this certificate becomes valid.

Syntax

amqpcontrol.SSLServerCertEffectiveDate

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

SSLServerCertExpirationDate Property (AMQP Control)

The date on which the certificate expires.

Syntax

amqpcontrol.SSLServerCertExpirationDate

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

SSLServerCertExtendedKeyUsage Property (AMQP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amqpcontrol.SSLServerCertExtendedKeyUsage

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

SSLServerCertFingerprint Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertFingerprint

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

SSLServerCertFingerprintSHA1 Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertFingerprintSHA1

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

SSLServerCertFingerprintSHA256 Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertFingerprintSHA256

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

SSLServerCertIssuer Property (AMQP Control)

The issuer of the certificate.

Syntax

amqpcontrol.SSLServerCertIssuer

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

SSLServerCertPrivateKey Property (AMQP Control)

The private key of the certificate (if available).

Syntax

amqpcontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (AMQP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amqpcontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (AMQP Control)

The public key of the certificate.

Syntax

amqpcontrol.SSLServerCertPublicKey

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

SSLServerCertPublicKeyAlgorithm Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertPublicKeyAlgorithm

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

SSLServerCertPublicKeyLength Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertPublicKeyLength

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

Integer

SSLServerCertSerialNumber Property (AMQP Control)

The serial number of the certificate encoded as a string.

Syntax

amqpcontrol.SSLServerCertSerialNumber

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

SSLServerCertSignatureAlgorithm Property (AMQP Control)

The text description of the certificate's signature algorithm.

Syntax

amqpcontrol.SSLServerCertSignatureAlgorithm

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

SSLServerCertStore Property (AMQP Control)

The name of the certificate store for the client certificate.

Syntax

amqpcontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertStorePassword

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

SSLServerCertStoreType Property (AMQP Control)

The type of certificate store for this certificate.

Syntax

amqpcontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (AMQP Control)

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

Syntax

amqpcontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (AMQP Control)

The MD5 hash of the certificate.

Syntax

amqpcontrol.SSLServerCertThumbprintMD5

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

SSLServerCertThumbprintSHA1 Property (AMQP Control)

The SHA-1 hash of the certificate.

Syntax

amqpcontrol.SSLServerCertThumbprintSHA1

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

SSLServerCertThumbprintSHA256 Property (AMQP Control)

The SHA-256 hash of the certificate.

Syntax

amqpcontrol.SSLServerCertThumbprintSHA256

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

SSLServerCertUsage Property (AMQP Control)

The text description of UsageFlags .

Syntax

amqpcontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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

SSLServerCertUsageFlags Property (AMQP Control)

The flags that show intended use for the certificate.

Syntax

amqpcontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (AMQP Control)

The certificate's version number.

Syntax

amqpcontrol.SSLServerCertVersion

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

SSLServerCertSubject Property (AMQP Control)

The subject of the certificate used for client authentication.

Syntax

amqpcontrol.SSLServerCertSubject

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=support@nsoftware.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

SSLServerCertEncoded Property (AMQP Control)

The certificate (PEM/Base64 encoded).

Syntax

amqpcontrol.SSLServerCertEncoded

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (AMQP Control)

This property includes the timeout for the control.

Syntax

amqpcontrol.Timeout[=integer]

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 control will wait for the operation to complete before returning control. The control will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The control will use DoEvents 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 control 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

Integer

User Property (AMQP Control)

A username to use for SASL authentication.

Syntax

amqpcontrol.User[=string]

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

This property is not available at design time.

Data Type

String

CloseLink Method (AMQP Control)

Closes a link.

Syntax

amqpcontrol.CloseLink Name

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.

CloseSession Method (AMQP Control)

Closes a session.

Syntax

amqpcontrol.CloseSession Name

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

Sets or retrieves a configuration setting.

Syntax

amqpcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)

This method connects to a remote host.

Syntax

amqpcontrol.Connect 

Remarks

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

ConnectTo Method (AMQP Control)

This method connects to a remote host.

Syntax

amqpcontrol.ConnectTo Host, Port

Remarks

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

CreateReceiverLink Method (AMQP Control)

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

Syntax

amqpcontrol.CreateReceiverLink SessionName, Name, Source

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 control will work to ensure that messages are received as soon as they are available; and retrieve-based, where the control will only "retrieve" a new message when explicitly instructed to.

The ReceiveMode 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");

CreateSenderLink Method (AMQP Control)

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

Syntax

amqpcontrol.CreateSenderLink SessionName, Name, Target

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 LinkReadyToSend 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 MessageSettled 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 SendMessage 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.

CreateSession Method (AMQP Control)

Creates a new session with the given name.

Syntax

amqpcontrol.CreateSession Name

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

This method disconnects from the remote host.

Syntax

amqpcontrol.Disconnect 

Remarks

This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.

DoEvents Method (AMQP Control)

This method processes events from the internal message queue.

Syntax

amqpcontrol.DoEvents 

Remarks

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

Interrupt Method (AMQP Control)

This method interrupts the current action.

Syntax

amqpcontrol.Interrupt 

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the control 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 Control)

This method will reset the control.

Syntax

amqpcontrol.Reset 

Remarks

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

ResetMessage Method (AMQP Control)

Resets the Message properties.

Syntax

amqpcontrol.ResetMessage 

Remarks

This method resets the Message property.

RetrieveMessage Method (AMQP Control)

Retrieves a single message over the specified receiver link.

Syntax

amqpcontrol.RetrieveMessage LinkName

Remarks

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

If RetrieveTimeout is non-zero, the control 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 control 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 ReceiveMode and RetrieveTimeout for more information.

SendMessage Method (AMQP Control)

Sends a message on the specified link.

Syntax

amqpcontrol.SendMessage LinkName

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 control 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 control requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).

The control 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 control 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 MessageSettled property to determine whether to send messages as settled or unsettled.

Sending Composite Data

Composite Data JSON Schema

The control 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 control 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 control 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"
    }
  ]
}

Connected Event (AMQP Control)

Fired immediately after a connection completes (or fails).

Syntax

Sub amqpcontrol_Connected(StatusCode As Integer, Description As String)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (AMQP Control)

Fired to indicate changes in the connection state.

Syntax

Sub amqpcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

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 ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (AMQP Control)

Fired when a connection is closed.

Syntax

Sub amqpcontrol_Disconnected(StatusCode As Integer, Description As String)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (AMQP Control)

Fired when information is available about errors during data delivery.

Syntax

Sub amqpcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

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

The ErrorCode 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.

LinkReadyToSend Event (AMQP Control)

Fires when a sender link is ready to send messages.

Syntax

Sub amqpcontrol_LinkReadyToSend(LinkName As String, LinkIndex As Integer)

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.

Log Event (AMQP Control)

Fires once for each log message.

Syntax

Sub amqpcontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event fires once for each log message generated by the control. 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 control.
• Session: Session status messages.
• Frame: Frame status messages.

MessageIn Event (AMQP Control)

Fires when the control receives a message.

Syntax

Sub amqpcontrol_MessageIn(SessionName As String, SessionIndex As Integer, LinkName As String, LinkIndex As Integer, MessageId As String, State As Integer)

Remarks

This event fires whenever the control receives a message. The message itself is automatically stored in the ReceivedMessage 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 control 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 control 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.

MessageOut Event (AMQP Control)

Fires when the control sends a message.

Syntax

Sub amqpcontrol_MessageOut(SessionName As String, SessionIndex As Integer, LinkName As String, LinkIndex As Integer, MessageId As String)

Remarks

This event fires whenever the control 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.

MessageOutcome Event (AMQP Control)

Fires when a message's outcome is available.

Syntax

Sub amqpcontrol_MessageOutcome(SessionName As String, SessionIndex As Integer, LinkName As String, LinkIndex As Integer, MessageId As String, Direction As Integer, State As Integer)

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.

SSLServerAuthentication Event (AMQP Control)

Fired after the server presents its certificate to the client.

Syntax

Sub amqpcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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.

SSLStatus Event (AMQP Control)

Fired when secure connection progress messages are available.

Syntax

Sub amqpcontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (AMQP Control)

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

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