AMQP Class

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Syntax

class ipworksmq.AMQP

Remarks

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

Connecting

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

Once connected, the next step is to create at least one session, which can be accomplished by using the create_session method. The class 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 class 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 class is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the class cannot accept any link requests made by other peers).

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

Creating Sender Links

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

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

Sending Messages

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

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

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

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

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

The reset_message method can be used to reset the Message* properties to their default values.

Sending Composite AMQP Data

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

Creating Receiver Links

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

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

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

Receiving Messages

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

Regardless of whether a messages is received automatically or fetched, any incoming message will cause the class to fire the on_message_in event and update the ReceivedMessage* properties.

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

auth_scheme Property

The authentication scheme to use when connecting.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

2

Remarks

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

Valid values are:

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

connected Property

This property triggers a connection or disconnection.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the host identified by the remote_host property. If successful, after the connection is achieved, the value of the property changes to True and the on_connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the linger property.

Note: It is recommended to use the connect or disconnect method instead of setting this property.

container_id Property

The container Id the class should advertise when connecting.

Syntax

def get_container_id() -> str: ...
def set_container_id(value: str) -> None: ...

container_id = property(get_container_id, set_container_id)

Default Value

""

Remarks

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

fetch_timeout Property

How long the class should wait for a message to be received after FetchMessage is called.

Syntax

def get_fetch_timeout() -> int: ...
def set_fetch_timeout(value: int) -> None: ...

fetch_timeout = property(get_fetch_timeout, set_fetch_timeout)

Default Value

60

Remarks

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

Refer to fetch_message for more information.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

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

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

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

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

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle_timeout Property

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

Syntax

def get_idle_timeout() -> int: ...
def set_idle_timeout(value: int) -> None: ...

idle_timeout = property(get_idle_timeout, set_idle_timeout)

Default Value

0

Remarks

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

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

Note: The idle timeout cannot be changed while connected.

incoming_message_count Property

The number of records in the IncomingMessage arrays.

Syntax

def get_incoming_message_count() -> int: ...

incoming_message_count = property(get_incoming_message_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is read-only.

incoming_message_absolute_expiry_time Property

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

Syntax

def get_incoming_message_absolute_expiry_time(incoming_message_index: int) -> int: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_content_encoding Property

The content encoding of this message's data.

Syntax

def get_incoming_message_content_encoding(incoming_message_index: int) -> str: ...

Default Value

""

Remarks

The content encoding of this message's data.

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

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

The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_content_type Property

The content type of this message's data.

Syntax

def get_incoming_message_content_type(incoming_message_index: int) -> str: ...

Default Value

""

Remarks

The content type of this message's data.

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

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

The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_correlation_id Property

The correlation Id of this message.

Syntax

def get_incoming_message_correlation_id(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_creation_time Property

The creation time of this message.

Syntax

def get_incoming_message_creation_time(incoming_message_index: int) -> int: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_delivery_count Property

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

Syntax

def get_incoming_message_delivery_count(incoming_message_index: int) -> int: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_durable Property

Whether this message is durable.

Syntax

def get_incoming_message_durable(incoming_message_index: int) -> bool: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_first_acquirer Property

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

Syntax

def get_incoming_message_first_acquirer(incoming_message_index: int) -> bool: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_group_id Property

The Id of the group this message belongs to.

Syntax

def get_incoming_message_group_id(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_group_sequence Property

The position of this message within its group.

Syntax

def get_incoming_message_group_sequence(incoming_message_index: int) -> int: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_link_name Property

The name of the link this message is associated with.

Syntax

def get_incoming_message_link_name(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_id Property

The unique Id of this message.

Syntax

def get_incoming_message_id(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_priority Property

The priority of this message.

Syntax

def get_incoming_message_priority(incoming_message_index: int) -> int: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_reply_to Property

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

Syntax

def get_incoming_message_reply_to(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_reply_to_group_id Property

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

Syntax

def get_incoming_message_reply_to_group_id(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_settled Property

Whether this message is settled.

Syntax

def get_incoming_message_settled(incoming_message_index: int) -> bool: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_subject Property

The subject of this message.

Syntax

def get_incoming_message_subject(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_to Property

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

Syntax

def get_incoming_message_to(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_ttl Property

The time-to-live value for this message.

Syntax

def get_incoming_message_ttl(incoming_message_index: int) -> int: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_user_id Property

The identity of the user responsible for producing this message.

Syntax

def get_incoming_message_user_id(incoming_message_index: int) -> str: ...

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 incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_value Property

This message's value.

Syntax

def get_incoming_message_value(incoming_message_index: int) -> str: ...

Default Value

""

Remarks

This message's value.

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

The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

incoming_message_value_type Property

This message's value data type.

Syntax

def get_incoming_message_value_type(incoming_message_index: int) -> int: ...

Default Value

0

Remarks

This message's value data type.

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

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

The incoming_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the incoming_message_count property.

This property is read-only.

link_count Property

The number of records in the Link arrays.

Syntax

def get_link_count() -> int: ...

link_count = property(get_link_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is read-only.

link_available Property

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

Syntax

def get_link_available(link_index: int) -> int: ...

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 link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_channel_name Property

The channel name this link is using.

Syntax

def get_link_channel_name(link_index: int) -> str: ...

Default Value

""

Remarks

The channel name this link is using.

This property holds the channel name this link is using.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_credit Property

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

Syntax

def get_link_credit(link_index: int) -> int: ...

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 link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_delivery_count Property

The current delivery count value for this link.

Syntax

def get_link_delivery_count(link_index: int) -> int: ...

Default Value

0

Remarks

The current delivery count value for this link.

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

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_name Property

This link's name.

Syntax

def get_link_name(link_index: int) -> str: ...

Default Value

""

Remarks

This link's name.

This property holds this link's name.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_ready_to_send Property

Whether this link is ready to send a message.

Syntax

def get_link_ready_to_send(link_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether this link is ready to send a message.

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

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_receive_mode Property

The receive mode this link is operating in.

Syntax

def get_link_receive_mode(link_index: int) -> int: ...

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
• lrmFetch - One message will be received after each call to the FetchMessage method.

Refer to receive_mode for more information.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_role Property

The class's role on this link.

Syntax

def get_link_role(link_index: int) -> int: ...

Default Value

0

Remarks

The class's role on this link.

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

• lrSender (0)
• lrReceiver (1)

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

local_port Property

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

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the local_port property after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

message_absolute_expiry_time Property

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

Syntax

def get_message_absolute_expiry_time() -> int: ...
def set_message_absolute_expiry_time(value: int) -> None: ...

message_absolute_expiry_time = property(get_message_absolute_expiry_time, set_message_absolute_expiry_time)

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

message_content_encoding Property

The content encoding of this message's data.

Syntax

def get_message_content_encoding() -> str: ...
def set_message_content_encoding(value: str) -> None: ...

message_content_encoding = property(get_message_content_encoding, set_message_content_encoding)

Default Value

""

Remarks

The content encoding of this message's data.

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

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

message_content_type Property

The content type of this message's data.

Syntax

def get_message_content_type() -> str: ...
def set_message_content_type(value: str) -> None: ...

message_content_type = property(get_message_content_type, set_message_content_type)

Default Value

""

Remarks

The content type of this message's data.

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

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

message_correlation_id Property

The correlation Id of this message.

Syntax

def get_message_correlation_id() -> str: ...
def set_message_correlation_id(value: str) -> None: ...

message_correlation_id = property(get_message_correlation_id, set_message_correlation_id)

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.

message_creation_time Property

The creation time of this message.

Syntax

def get_message_creation_time() -> int: ...
def set_message_creation_time(value: int) -> None: ...

message_creation_time = property(get_message_creation_time, set_message_creation_time)

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

message_delivery_count Property

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

Syntax

def get_message_delivery_count() -> int: ...
def set_message_delivery_count(value: int) -> None: ...

message_delivery_count = property(get_message_delivery_count, set_message_delivery_count)

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.

message_durable Property

Whether this message is durable.

Syntax

def get_message_durable() -> bool: ...
def set_message_durable(value: bool) -> None: ...

message_durable = property(get_message_durable, set_message_durable)

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.

message_first_acquirer Property

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

Syntax

def get_message_first_acquirer() -> bool: ...
def set_message_first_acquirer(value: bool) -> None: ...

message_first_acquirer = property(get_message_first_acquirer, set_message_first_acquirer)

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.

message_group_id Property

The Id of the group this message belongs to.

Syntax

def get_message_group_id() -> str: ...
def set_message_group_id(value: str) -> None: ...

message_group_id = property(get_message_group_id, set_message_group_id)

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.

message_group_sequence Property

The position of this message within its group.

Syntax

def get_message_group_sequence() -> int: ...
def set_message_group_sequence(value: int) -> None: ...

message_group_sequence = property(get_message_group_sequence, set_message_group_sequence)

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.

message_link_name Property

The name of the link this message is associated with.

Syntax

def get_message_link_name() -> str: ...

message_link_name = property(get_message_link_name, None)

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.

message_id Property

The unique Id of this message.

Syntax

def get_message_id() -> str: ...
def set_message_id(value: str) -> None: ...

message_id = property(get_message_id, set_message_id)

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.

message_priority Property

The priority of this message.

Syntax

def get_message_priority() -> int: ...
def set_message_priority(value: int) -> None: ...

message_priority = property(get_message_priority, set_message_priority)

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

message_reply_to Property

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

Syntax

def get_message_reply_to() -> str: ...
def set_message_reply_to(value: str) -> None: ...

message_reply_to = property(get_message_reply_to, set_message_reply_to)

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.

message_reply_to_group_id Property

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

Syntax

def get_message_reply_to_group_id() -> str: ...
def set_message_reply_to_group_id(value: str) -> None: ...

message_reply_to_group_id = property(get_message_reply_to_group_id, set_message_reply_to_group_id)

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.

message_settled Property

Whether this message is settled.

Syntax

def get_message_settled() -> bool: ...
def set_message_settled(value: bool) -> None: ...

message_settled = property(get_message_settled, set_message_settled)

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

message_subject Property

The subject of this message.

Syntax

def get_message_subject() -> str: ...
def set_message_subject(value: str) -> None: ...

message_subject = property(get_message_subject, set_message_subject)

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.

message_to Property

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

Syntax

def get_message_to() -> str: ...
def set_message_to(value: str) -> None: ...

message_to = property(get_message_to, set_message_to)

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.

message_ttl Property

The time-to-live value for this message.

Syntax

def get_message_ttl() -> int: ...
def set_message_ttl(value: int) -> None: ...

message_ttl = property(get_message_ttl, set_message_ttl)

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.

message_user_id Property

The identity of the user responsible for producing this message.

Syntax

def get_message_user_id() -> str: ...
def set_message_user_id(value: str) -> None: ...

message_user_id = property(get_message_user_id, set_message_user_id)

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.

message_value Property

This message's value.

Syntax

def get_message_value() -> str: ...
def set_message_value(value: str) -> None: ...

message_value = property(get_message_value, set_message_value)

Default Value

""

Remarks

This message's value.

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

message_value_type Property

This message's value data type.

Syntax

def get_message_value_type() -> int: ...
def set_message_value_type(value: int) -> None: ...

message_value_type = property(get_message_value_type, set_message_value_type)

Default Value

0

Remarks

This message's value data type.

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

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

outgoing_message_count Property

The number of records in the OutgoingMessage arrays.

Syntax

def get_outgoing_message_count() -> int: ...

outgoing_message_count = property(get_outgoing_message_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is read-only.

outgoing_message_absolute_expiry_time Property

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

Syntax

def get_outgoing_message_absolute_expiry_time(outgoing_message_index: int) -> int: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_content_encoding Property

The content encoding of this message's data.

Syntax

def get_outgoing_message_content_encoding(outgoing_message_index: int) -> str: ...

Default Value

""

Remarks

The content encoding of this message's data.

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

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

The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_content_type Property

The content type of this message's data.

Syntax

def get_outgoing_message_content_type(outgoing_message_index: int) -> str: ...

Default Value

""

Remarks

The content type of this message's data.

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

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

The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_correlation_id Property

The correlation Id of this message.

Syntax

def get_outgoing_message_correlation_id(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_creation_time Property

The creation time of this message.

Syntax

def get_outgoing_message_creation_time(outgoing_message_index: int) -> int: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_delivery_count Property

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

Syntax

def get_outgoing_message_delivery_count(outgoing_message_index: int) -> int: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_durable Property

Whether this message is durable.

Syntax

def get_outgoing_message_durable(outgoing_message_index: int) -> bool: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_first_acquirer Property

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

Syntax

def get_outgoing_message_first_acquirer(outgoing_message_index: int) -> bool: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_group_id Property

The Id of the group this message belongs to.

Syntax

def get_outgoing_message_group_id(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_group_sequence Property

The position of this message within its group.

Syntax

def get_outgoing_message_group_sequence(outgoing_message_index: int) -> int: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_link_name Property

The name of the link this message is associated with.

Syntax

def get_outgoing_message_link_name(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_id Property

The unique Id of this message.

Syntax

def get_outgoing_message_id(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_priority Property

The priority of this message.

Syntax

def get_outgoing_message_priority(outgoing_message_index: int) -> int: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_reply_to Property

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

Syntax

def get_outgoing_message_reply_to(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_reply_to_group_id Property

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

Syntax

def get_outgoing_message_reply_to_group_id(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_settled Property

Whether this message is settled.

Syntax

def get_outgoing_message_settled(outgoing_message_index: int) -> bool: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_subject Property

The subject of this message.

Syntax

def get_outgoing_message_subject(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_to Property

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

Syntax

def get_outgoing_message_to(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_ttl Property

The time-to-live value for this message.

Syntax

def get_outgoing_message_ttl(outgoing_message_index: int) -> int: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_user_id Property

The identity of the user responsible for producing this message.

Syntax

def get_outgoing_message_user_id(outgoing_message_index: int) -> str: ...

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 outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_value Property

This message's value.

Syntax

def get_outgoing_message_value(outgoing_message_index: int) -> str: ...

Default Value

""

Remarks

This message's value.

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

The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

outgoing_message_value_type Property

This message's value data type.

Syntax

def get_outgoing_message_value_type(outgoing_message_index: int) -> int: ...

Default Value

0

Remarks

This message's value data type.

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

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

The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.

password Property

A password to use for SASL authentication.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

ready_to_send Property

Indicates whether the class is ready to send data.

Syntax

def get_ready_to_send() -> bool: ...

ready_to_send = property(get_ready_to_send, None)

Default Value

FALSE

Remarks

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

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

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

This property is read-only.

received_message_absolute_expiry_time Property

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

Syntax

def get_received_message_absolute_expiry_time() -> int: ...

received_message_absolute_expiry_time = property(get_received_message_absolute_expiry_time, None)

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.

received_message_content_encoding Property

The content encoding of this message's data.

Syntax

def get_received_message_content_encoding() -> str: ...

received_message_content_encoding = property(get_received_message_content_encoding, None)

Default Value

""

Remarks

The content encoding of this message's data.

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

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

This property is read-only.

received_message_content_type Property

The content type of this message's data.

Syntax

def get_received_message_content_type() -> str: ...

received_message_content_type = property(get_received_message_content_type, None)

Default Value

""

Remarks

The content type of this message's data.

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

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

This property is read-only.

received_message_correlation_id Property

The correlation Id of this message.

Syntax

def get_received_message_correlation_id() -> str: ...

received_message_correlation_id = property(get_received_message_correlation_id, None)

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.

received_message_creation_time Property

The creation time of this message.

Syntax

def get_received_message_creation_time() -> int: ...

received_message_creation_time = property(get_received_message_creation_time, None)

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.

received_message_delivery_count Property

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

Syntax

def get_received_message_delivery_count() -> int: ...

received_message_delivery_count = property(get_received_message_delivery_count, None)

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.

received_message_durable Property

Whether this message is durable.

Syntax

def get_received_message_durable() -> bool: ...

received_message_durable = property(get_received_message_durable, None)

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.

received_message_first_acquirer Property

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

Syntax

def get_received_message_first_acquirer() -> bool: ...

received_message_first_acquirer = property(get_received_message_first_acquirer, None)

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.

received_message_group_id Property

The Id of the group this message belongs to.

Syntax

def get_received_message_group_id() -> str: ...

received_message_group_id = property(get_received_message_group_id, None)

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.

received_message_group_sequence Property

The position of this message within its group.

Syntax

def get_received_message_group_sequence() -> int: ...

received_message_group_sequence = property(get_received_message_group_sequence, None)

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.

received_message_link_name Property

The name of the link this message is associated with.

Syntax

def get_received_message_link_name() -> str: ...

received_message_link_name = property(get_received_message_link_name, None)

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.

received_message_id Property

The unique Id of this message.

Syntax

def get_received_message_id() -> str: ...

received_message_id = property(get_received_message_id, None)

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.

received_message_priority Property

The priority of this message.

Syntax

def get_received_message_priority() -> int: ...

received_message_priority = property(get_received_message_priority, None)

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.

received_message_reply_to Property

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

Syntax

def get_received_message_reply_to() -> str: ...

received_message_reply_to = property(get_received_message_reply_to, None)

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.

received_message_reply_to_group_id Property

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

Syntax

def get_received_message_reply_to_group_id() -> str: ...

received_message_reply_to_group_id = property(get_received_message_reply_to_group_id, None)

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.

received_message_settled Property

Whether this message is settled.

Syntax

def get_received_message_settled() -> bool: ...

received_message_settled = property(get_received_message_settled, None)

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.

received_message_subject Property

The subject of this message.

Syntax

def get_received_message_subject() -> str: ...

received_message_subject = property(get_received_message_subject, None)

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.

received_message_to Property

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

Syntax

def get_received_message_to() -> str: ...

received_message_to = property(get_received_message_to, None)

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.

received_message_ttl Property

The time-to-live value for this message.

Syntax

def get_received_message_ttl() -> int: ...

received_message_ttl = property(get_received_message_ttl, None)

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.

received_message_user_id Property

The identity of the user responsible for producing this message.

Syntax

def get_received_message_user_id() -> str: ...

received_message_user_id = property(get_received_message_user_id, None)

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.

received_message_value Property

This message's value.

Syntax

def get_received_message_value() -> str: ...

received_message_value = property(get_received_message_value, None)

Default Value

""

Remarks

This message's value.

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

This property is read-only.

received_message_value_type Property

This message's value data type.

Syntax

def get_received_message_value_type() -> int: ...

received_message_value_type = property(get_received_message_value_type, None)

Default Value

0

Remarks

This message's value data type.

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

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

This property is read-only.

receive_mode Property

Controls what mode new receiver links are created with.

Syntax

def get_receive_mode() -> int: ...
def set_receive_mode(value: int) -> None: ...

receive_mode = property(get_receive_mode, set_receive_mode)

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)
• rmFetch (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 class will automatically set it back to its initial value.

Fetching Messages On-Demand

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

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

Refer to fetch_message and fetch_timeout for more information. amqp.ReceiveMode = AmqpReceiveModes.rmFetch; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

remote_host Property

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

Syntax

def get_remote_host() -> str: ...
def set_remote_host(value: str) -> None: ...

remote_host = property(get_remote_host, set_remote_host)

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

remote_port Property

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

Syntax

def get_remote_port() -> int: ...
def set_remote_port(value: int) -> None: ...

remote_port = property(get_remote_port, set_remote_port)

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.

session_count Property

The number of records in the Session arrays.

Syntax

def get_session_count() -> int: ...

session_count = property(get_session_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• session_incoming_window
• session_name
• session_outgoing_window

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

This property is read-only.

session_incoming_window Property

The incoming window size of this session.

Syntax

def get_session_incoming_window(session_index: int) -> int: ...

Default Value

0

Remarks

The incoming window size of this session.

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

The session_index parameter specifies the index of the item in the array. The size of the array is controlled by the session_count property.

This property is read-only.

session_name Property

The name of this session.

Syntax

def get_session_name(session_index: int) -> str: ...

Default Value

""

Remarks

The name of this session.

This property holds the name of this session.

The session_index parameter specifies the index of the item in the array. The size of the array is controlled by the session_count property.

This property is read-only.

session_outgoing_window Property

The outgoing window size of this session.

Syntax

def get_session_outgoing_window(session_index: int) -> int: ...

Default Value

0

Remarks

The outgoing window size of this session.

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

The session_index parameter specifies the index of the item in the array. The size of the array is controlled by the session_count property.

This property is read-only.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is 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.

ssl_enabled Property

Whether TLS/SSL is enabled.

Syntax

def get_ssl_enabled() -> bool: ...
def set_ssl_enabled(value: bool) -> None: ...

ssl_enabled = property(get_ssl_enabled, set_ssl_enabled)

Default Value

FALSE

Remarks

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

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

If the default port (5672) is selected when SSLEnabled is set to true, the port will automatically be changed to the default port for AMQP with SSL (5671). Likewise, if port 5671 is selected when SSLEnabled is set to false, the port will automatically be changed to the default port. If the port has been set to any value other than the default values, it will remain the same when the value of SSLEnabled changes.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

user Property

A username to use for SASL authentication.

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

close_link Method

Closes a link.

Syntax

def close_link(name: str) -> None: ...

Remarks

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

close_session Method

Closes a session.

Syntax

def close_session(name: str) -> None: ...

Remarks

This method closes the session named Name and removes it from the Session* 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 Link* properties.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

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

This method connects to a remote host.

Syntax

def connect() -> None: ...

Remarks

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

connect_to Method

This method connects to a remote host.

Syntax

def connect_to(host: str, port: int) -> None: ...

Remarks

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

create_receiver_link Method

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

Syntax

def create_receiver_link(session_name: str, name: str, source: str) -> None: ...

Remarks

This method creates a new receiver link with the given Name on the session specified by SessionName and adds it to the Link* 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 class will work to ensure that messages are received as soon as they are available; and fetch-based, where the class will only "fetch" a new message when explicitly instructed to.

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

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

create_sender_link Method

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

Syntax

def create_sender_link(session_name: str, name: str, target: str) -> None: ...

Remarks

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

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

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

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

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

create_session Method

Creates a new session with the given name.

Syntax

def create_session(name: str) -> None: ...

Remarks

This method creates a new session with the given Name and adds it to the Session* 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

This method disconnects from the remote host.

Syntax

def disconnect() -> None: ...

Remarks

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

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

fetch_message Method

Fetches a single message over the specified receiver link.

Syntax

def fetch_message(link_name: str) -> None: ...

Remarks

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

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

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

Refer to receive_mode and fetch_timeout for more information.

interrupt Method

This method interrupts the current action.

Syntax

def interrupt() -> None: ...

Remarks

This method interrupts the current action. If you use send_file to upload a file, the class 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

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

reset_message Method

Resets the Message properties.

Syntax

def reset_message() -> None: ...

Remarks

This method resets the Message* properties.

send_message Method

Sends a message on the specified link.

Syntax

def send_message(link_name: str) -> None: ...

Remarks

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

The Message* properties are used to construct the message to send. At minimum, specify a MessageValue and a MessageValueType; all other properties are optional. The reset_message method can be used to reset the Message* properties. 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 class 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 class requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).

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

Sending Composite Data

Composite Data JSON Schema

The class 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 class 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 class defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the SimplifiedJSONFormat configuration setting.

Composite Data JSON Example

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

on_connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

class AMQPConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AMQP:
@property
def on_connected() -> Callable[[AMQPConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[AMQPConnectedEventParams], None]) -> None: ...

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.

Please refer to the Error Codes section for more information.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

class AMQPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AMQP:
@property
def on_connection_status() -> Callable[[AMQPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[AMQPConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class AMQPDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class AMQP:
@property
def on_disconnected() -> Callable[[AMQPDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[AMQPDisconnectedEventParams], None]) -> None: ...

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.

Please refer to the Error Codes section for more information.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class AMQPErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AMQP:
@property
def on_error() -> Callable[[AMQPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AMQPErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class 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.

on_link_ready_to_send Event

Fires when a sender link is ready to send messages.

Syntax

class AMQPLinkReadyToSendEventParams(object):
  @property
  def link_name() -> str: ...

  @property
  def link_index() -> int: ...

# In class AMQP:
@property
def on_link_ready_to_send() -> Callable[[AMQPLinkReadyToSendEventParams], None]: ...
@on_link_ready_to_send.setter
def on_link_ready_to_send(event_hook: Callable[[AMQPLinkReadyToSendEventParams], None]) -> None: ...

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 Link* properties.

on_log Event

Fires once for each log message.

Syntax

class AMQPLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class AMQP:
@property
def on_log() -> Callable[[AMQPLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AMQPLogEventParams], None]) -> None: ...

Remarks

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

on_message_in Event

Fires when the class receives a message.

Syntax

class AMQPMessageInEventParams(object):
  @property
  def session_name() -> str: ...

  @property
  def session_index() -> int: ...

  @property
  def link_name() -> str: ...

  @property
  def link_index() -> int: ...

  @property
  def message_id() -> str: ...

  @property
  def state() -> int: ...
  @state.setter
  def state(value) -> None: ...

# In class AMQP:
@property
def on_message_in() -> Callable[[AMQPMessageInEventParams], None]: ...
@on_message_in.setter
def on_message_in(event_hook: Callable[[AMQPMessageInEventParams], None]) -> None: ...

Remarks

This event fires whenever the class receives a message. The message itself is automatically stored in the ReceivedMessage* properties.

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 class 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 class 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 Session* properties.

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

LinkIndex is the index of the link in the Link* properties.

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

on_message_out Event

Fires when the class sends a message.

Syntax

class AMQPMessageOutEventParams(object):
  @property
  def session_name() -> str: ...

  @property
  def session_index() -> int: ...

  @property
  def link_name() -> str: ...

  @property
  def link_index() -> int: ...

  @property
  def message_id() -> str: ...

# In class AMQP:
@property
def on_message_out() -> Callable[[AMQPMessageOutEventParams], None]: ...
@on_message_out.setter
def on_message_out(event_hook: Callable[[AMQPMessageOutEventParams], None]) -> None: ...

Remarks

This event fires whenever the class sends a message.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the Session* properties.

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

LinkIndex is the index of the link in the Link* properties.

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

on_message_outcome Event

Fires when a message's outcome is available.

Syntax

class AMQPMessageOutcomeEventParams(object):
  @property
  def session_name() -> str: ...

  @property
  def session_index() -> int: ...

  @property
  def link_name() -> str: ...

  @property
  def link_index() -> int: ...

  @property
  def message_id() -> str: ...

  @property
  def direction() -> int: ...

  @property
  def state() -> int: ...

# In class AMQP:
@property
def on_message_outcome() -> Callable[[AMQPMessageOutcomeEventParams], None]: ...
@on_message_outcome.setter
def on_message_outcome(event_hook: Callable[[AMQPMessageOutcomeEventParams], None]) -> None: ...

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 Session* properties.

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

LinkIndex is the index of the link in the Link* properties.

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

Direction indicates whether this outcome was sent (0) or received (1).

State indicates the actual message outcome. Possible values are:

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

When State is Rejected (1), the RejectErrorCondition and RejectErrorDescription configuration settings can be queried before the event handler finishes to retrieve the error information.

When State is Modified (3), the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings can be queried before the event handler finishes to retrieve the additional metadata.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class AMQPSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AMQP:
@property
def on_ssl_server_authentication() -> Callable[[AMQPSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AMQPSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class AMQPSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AMQP:
@property
def on_ssl_status() -> Callable[[AMQPSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AMQPSSLStatusEventParams], None]) -> None: ...

Remarks

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

AMQP Config Settings

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
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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

Socket Config Settings

AMQP Errors

AMQP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors