Share via

AMQPClient Class

  • Reference

An AMQP client.

Inheritance
builtins.object
AMQPClient

Constructor

AMQPClient(remote_address, auth=None, client_name=None, debug=False, error_policy=None, keep_alive_interval=None, **kwargs)

Parameters

Name Description
remote_address
Required
str, bytes or Address

The AMQP endpoint to connect to. This could be a send target or a receive source.
auth
AMQPAuth

Authentication for the connection. This should be one of the subclasses of uamqp.authentication.AMQPAuth. Currently this includes:

  • uamqp.authentication.SASLAnonymous

  • uamqp.authentication.SASLPlain

  • uamqp.authentication.SASTokenAuth

  • uamqp.authentication.JWTTokenAuth

If no authentication is supplied, SASLAnnoymous will be used by default.

default value: None
client_name
str or bytes

The name for the client, also known as the Container ID. If no name is provided, a random GUID will be used.

default value: None
debug
bool

Whether to turn on network trace logs. If True, trace logs will be logged at INFO level. Default is False.

default value: False
error_policy
ErrorPolicy

A policy for parsing errors on link, connection and message disposition to determine whether the error should be retryable.

default value: None
keep_alive_interval
int

If set, a thread will be started to keep the connection alive during periods of user inactivity. The value will determine how long the thread will sleep (in seconds) between pinging the connection. If 0 or None, no thread will be started.

default value: None
max_frame_size
Required
int

Maximum AMQP frame size. Default is 63488 bytes.
channel_max
Required
int

Maximum number of Session channels in the Connection.
idle_timeout
Required
int

Timeout in milliseconds after which the Connection will close if there is no further activity.
properties
Required
dict

Connection properties.
remote_idle_timeout_empty_frame_send_ratio
Required
float

Ratio of empty frames to idle time for Connections with no activity. Value must be between 0.0 and 1.0 inclusive. Default is 0.5.
incoming_window
Required
int

The size of the allowed window for incoming messages.
outgoing_window
Required
int

The size of the allowed window for outgoing messages.
handle_max
Required
int

The maximum number of concurrent link handles.
on_attach
Required
<xref:func>[Source, Target, dict, AMQPConnectionError]

A callback function to be run on receipt of an ATTACH frame. The function must take 4 arguments: source, target, properties and error.
send_settle_mode
Required
SenderSettleMode

The mode by which to settle message send operations. If set to Unsettled, the client will wait for a confirmation from the service that the message was successfully sent. If set to 'Settled', the client will not wait for confirmation and assume success.
receive_settle_mode
Required
ReceiverSettleMode

The mode by which to settle message receive operations. If set to PeekLock, the receiver will lock a message once received until the client accepts or rejects the message. If set to ReceiveAndDelete, the service will assume successful receipt of the message and clear it from the queue. The default is PeekLock.
encoding
Required
str

The encoding to use for parameters supplied as strings. Default is 'UTF-8'

Methods

auth_complete

Whether the authentication handshake is complete during connection initialization.
client_ready

Whether the handler has completed all start up processes such as establishing the connection, session, link and authentication, and is not ready to process messages.
close

Close the client. This includes closing the Session and CBS authentication layer as well as the Connection. If the client was opened using an external Connection, this will be left intact.

No further messages can be sent or received and the client cannot be re-opened.

All pending, unsent messages will remain uncleared to allow them to be inspected and queued to a new client.
do_work

Run a single connection iteration. This will return True if the connection is still open and ready to be used for further work, or False if it needs to be shut down.
mgmt_request

Run a request/response operation. These are frequently used for management tasks against a $management node, however any node name can be specified and the available options will depend on the target service.
open

Open the client. The client can create a new Connection or an existing Connection can be passed in. This existing Connection may have an existing CBS authentication Session, which will be used for this client as well. Otherwise a new Session will be created.

auth_complete

Whether the authentication handshake is complete during connection initialization.

auth_complete()

Returns

Type Description
bool

client_ready

Whether the handler has completed all start up processes such as establishing the connection, session, link and authentication, and is not ready to process messages.

client_ready()

Returns

Type Description
bool

close

Close the client. This includes closing the Session and CBS authentication layer as well as the Connection. If the client was opened using an external Connection, this will be left intact.

No further messages can be sent or received and the client cannot be re-opened.

All pending, unsent messages will remain uncleared to allow them to be inspected and queued to a new client.

close()

do_work

Run a single connection iteration. This will return True if the connection is still open and ready to be used for further work, or False if it needs to be shut down.

do_work(**kwargs)

Returns

Type Description
bool

Exceptions

Type Description
TimeoutError or uamqp.errors.ClientTimeout if CBS authentication timeout reached.

mgmt_request

Run a request/response operation. These are frequently used for management tasks against a $management node, however any node name can be specified and the available options will depend on the target service.

mgmt_request(message, operation, op_type=None, node=None, callback=None, **kwargs)

Parameters

Name Description
message
Required
Message

The message to send in the management request.
operation
Required
bytes

The type of operation to be performed. This value will be service-specific, but common values include READ, CREATE and UPDATE. This value will be added as an application property on the message.
op_type
bytes

The type on which to carry out the operation. This will be specific to the entities of the service. This value will be added as an application property on the message.

default value: None
node
bytes

The target node. Default is b"$management".

default value: None
timeout
Required
float

Provide an optional timeout in milliseconds within which a response to the management request must be received.
callback
callable[int, bytes, Message]

The function to process the returned parameters of the management request including status code and a description if available. This can be used to reformat the response or raise an error based on content. The function must take 3 arguments - status code, response message and description.

default value: None
status_code_field
Required
bytes

Provide an alternate name for the status code in the response body which can vary between services due to the spec still being in draft. The default is b"statusCode".
description_fields
Required
bytes

Provide an alternate name for the description in the response body which can vary between services due to the spec still being in draft. The default is b"statusDescription".

Returns

Type Description
Message

open

Open the client. The client can create a new Connection or an existing Connection can be passed in. This existing Connection may have an existing CBS authentication Session, which will be used for this client as well. Otherwise a new Session will be created.

open(connection=None)

Parameters

Name Description
connection

An existing Connection that may be shared between multiple clients.

default value: None