pamqp.commands¶
The classes inside pamqp.commands
allow for the automatic marshaling and unmarshaling of AMQP method frames and Basic.Properties
. In addition the command classes contain information that designates if they are synchronous commands and if so, what the expected responses are. Each commands arguments are detailed in the class and are listed in the attributes property.
Note
All AMQ classes and methods extend pamqp.base.Frame
.
- class
pamqp.commands.
Connection
[source]¶ Work with socket connections
The connection class provides methods for a client to establish a network connection to a server, and for both peers to operate the connection thereafter.
- class
Start
(version_major=0, version_minor=9, server_properties=None, mechanisms='PLAIN', locales='en_US')[source]¶ Start connection negotiation
This method starts the connection negotiation process by telling the client the protocol version that the server proposes, along with a list of security mechanisms which the client can use for authentication.
- Parameters
version_major (
int
) – Protocol major version - Default:0
version_minor (
int
) – Protocol minor version - Default:9
server_properties (
FieldTable
) – Server properties - Default:{}
mechanisms (
str
) – Available security mechanisms - Default:PLAIN
locales (
str
) – Available message locales - Default:en_US
- class
StartOk
(client_properties=None, mechanism='PLAIN', response='', locale='en_US')[source]¶ Select security mechanism and locale
This method selects a SASL security mechanism.
- Parameters
client_properties (
FieldTable
) – Client properties - Default:{}
mechanism (
str
) – Selected security mechanism - Default:PLAIN
response (
str
) – Security response data - Default:''
locale (
str
) – Selected message locale - Default:en_US
- class
Secure
(challenge=None)[source]¶ Security mechanism challenge
The SASL protocol works by exchanging challenges and responses until both peers have received sufficient information to authenticate each other. This method challenges the client to provide more information.
- Parameters
challenge (
typing.Optional
[str
]) – Security challenge data
- class
SecureOk
(response=None)[source]¶ Security mechanism response
This method attempts to authenticate, passing a block of SASL data for the security mechanism at the server side.
- Parameters
response (
typing.Optional
[str
]) – Security response data
- class
Tune
(channel_max=0, frame_max=0, heartbeat=0)[source]¶ Propose connection tuning parameters
This method proposes a set of connection configuration values to the client. The client can accept and/or adjust these.
- class
TuneOk
(channel_max=0, frame_max=0, heartbeat=0)[source]¶ Negotiate connection tuning parameters
This method sends the client’s connection tuning parameters to the server. Certain fields are negotiated, others provide capability information.
- class
Open
(virtual_host='/', capabilities='', insist=False)[source]¶ Open connection to virtual host
This method opens a connection to a virtual host, which is a collection of resources, and acts to separate multiple application domains within a server. The server may apply arbitrary limits per virtual host, such as the number of each type of entity that may be used, per connection and/or in total.
- Parameters
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
OpenOk
(known_hosts='')[source]¶ Signal that connection is ready
This method signals to the client that the connection is ready for use.
- Parameters
known_hosts (
str
) – Deprecated, must be empty - Default:''
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Close
(reply_code=None, reply_text='', class_id=None, method_id=None)[source]¶ Request a connection close
This method indicates that the sender wants to close the connection. This may be due to internal conditions (e.g. a forced shut-down) or due to an error handling a specific method, i.e. an exception. When a close is due to an exception, the sender provides the class and method id of the method which caused the exception.
- Parameters
reply_code (
typing.Optional
[int
]) – Reply code from serverreply_text (
str
) – Localised reply text - Default:''
class_id (
typing.Optional
[int
]) – Failing method classmethod_id (
typing.Optional
[int
]) – Failing method ID
- class
CloseOk
[source]¶ Confirm a connection close
This method confirms a
Connection.Close
method and tells the recipient that it is safe to release resources for the connection and close the socket.
- class
Blocked
(reason='')[source]¶ Indicate that connection is blocked
This method indicates that a connection has been blocked and does not accept new publishes.
- Parameters
reason (
str
) – Block reason - Default:''
- class
Unblocked
[source]¶ Indicate that connection is unblocked
This method indicates that a connection has been unblocked and now accepts publishes.
- class
UpdateSecret
(new_secret=None, reason=None)[source]¶ Update secret
This method updates the secret used to authenticate this connection. It is used when secrets have an expiration date and need to be renewed, like OAuth 2 tokens.
- Parameters
new_secret (
typing.Optional
[str
]) – New secretreason (
typing.Optional
[str
]) – Reason
- class
- class
pamqp.commands.
Channel
[source]¶ Work with channels
The channel class provides methods for a client to establish a channel to a server and for both peers to operate the channel thereafter.
- class
Open
(out_of_band='0')[source]¶ Open a channel for use
This method opens a channel to the server.
- Parameters
out_of_band (
str
) – Protocol level field, do not use, must be0
. - Default:0
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
OpenOk
(channel_id='0')[source]¶ Signal that the channel is ready
This method signals to the client that the channel is ready for use.
- Parameters
channel_id (
str
) – Deprecated, must be0
- Default:0
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Flow
(active=None)[source]¶ Enable/disable flow from peer
This method asks the peer to pause or restart the flow of content data sent by a consumer. This is a simple flow-control mechanism that a peer can use to avoid overflowing its queues or otherwise finding itself receiving more messages than it can process. Note that this method is not intended for window control. It does not affect contents returned by
Basic.GetOk
methods.- Parameters
active (
typing.Optional
[bool
]) – Start/stop content frames
- class
FlowOk
(active=None)[source]¶ Confirm a flow method
Confirms to the peer that a flow command was received and processed.
- Parameters
active (
typing.Optional
[bool
]) – Current flow setting
- class
Close
(reply_code=None, reply_text='', class_id=None, method_id=None)[source]¶ Request a channel close
This method indicates that the sender wants to close the channel. This may be due to internal conditions (e.g. a forced shut-down) or due to an error handling a specific method, i.e. an exception. When a close is due to an exception, the sender provides the class and method id of the method which caused the exception.
- Parameters
reply_code (
typing.Optional
[int
]) – Reply code from serverreply_text (
str
) – Localised reply text - Default:''
class_id (
typing.Optional
[int
]) – Failing method classmethod_id (
typing.Optional
[int
]) – Failing method ID
- class
CloseOk
[source]¶ Confirm a channel close
This method confirms a
Channel.Close
method and tells the recipient that it is safe to release resources for the channel.
- class
- class
pamqp.commands.
Exchange
[source]¶ Work with exchanges
Exchanges match and distribute messages across queues. Exchanges can be configured in the server or declared at runtime.
- class
Declare
(ticket=0, exchange='', exchange_type='direct', passive=False, durable=False, auto_delete=False, internal=False, nowait=False, arguments=None)[source]¶ Verify exchange exists, create if needed
This method creates an exchange if it does not already exist, and if the exchange exists, verifies that it is of the correct and expected class.
Note
The AMQP type argument is referred to as “exchange_type” to not conflict with the Python type keyword.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
exchange (
str
) – exchange name - Default:''
exchange_type (
str
) – Exchange type - Default:direct
passive (
bool
) – Do not create exchange - Default:False
durable (
bool
) – Request a durable exchange - Default:False
auto_delete (
bool
) – Auto-delete when unused - Default:False
internal (
bool
) – Create internal exchange - Default:False
nowait (
bool
) – Do not send a reply method - Default:False
arguments (
Arguments
) – Arguments for declaration - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
DeclareOk
[source]¶ Confirm exchange declaration
This method confirms a Declare method and confirms the name of the exchange, essential for automatically-named exchanges.
- class
Delete
(ticket=0, exchange='', if_unused=False, nowait=False)[source]¶ Delete an exchange
This method deletes an exchange. When an exchange is deleted all queue bindings on the exchange are cancelled.
- Parameters
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
DeleteOk
[source]¶ Confirm deletion of an exchange
This method confirms the deletion of an exchange.
- class
Bind
(ticket=0, destination='', source='', routing_key='', nowait=False, arguments=None)[source]¶ Bind exchange to an exchange
This method binds an exchange to an exchange.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
destination (
str
) – Name of the destination exchange to bind to - Default:''
source (
str
) – Name of the source exchange to bind to - Default:''
routing_key (
str
) – Message routing key - Default:''
nowait (
bool
) – Do not send a reply method - Default:False
arguments (
Arguments
) – Arguments for binding - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Unbind
(ticket=0, destination='', source='', routing_key='', nowait=False, arguments=None)[source]¶ Unbind an exchange from an exchange
This method unbinds an exchange from an exchange.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
destination (
str
) – Specifies the name of the destination exchange to unbind. - Default:''
source (
str
) – Specifies the name of the source exchange to unbind. - Default:''
routing_key (
str
) – Routing key of binding - Default:''
nowait (
bool
) – Do not send a reply method - Default:False
arguments (
Arguments
) – Arguments of binding - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
- class
pamqp.commands.
Queue
[source]¶ Work with queues
Queues store and forward messages. Queues can be configured in the server or created at runtime. Queues must be attached to at least one exchange in order to receive messages from publishers.
- class
Declare
(ticket=0, queue='', passive=False, durable=False, exclusive=False, auto_delete=False, nowait=False, arguments=None)[source]¶ Declare queue, create if needed
This method creates or checks a queue. When creating a new queue the client can specify various properties that control the durability of the queue and its contents, and the level of sharing for the queue.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
queue (
str
) – queue name - Default:''
passive (
bool
) – Do not create queue - Default:False
durable (
bool
) – Request a durable queue - Default:False
exclusive (
bool
) – Request an exclusive queue - Default:False
auto_delete (
bool
) – Auto-delete queue when unused - Default:False
nowait (
bool
) – Do not send a reply method - Default:False
arguments (
Arguments
) – Arguments for declaration - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
DeclareOk
(queue=None, message_count=None, consumer_count=None)[source]¶ Confirms a queue definition
This method confirms a Declare method and confirms the name of the queue, essential for automatically-named queues.
- Parameters
queue (
typing.Optional
[str
]) – Reports the name of the queue. If the server generated a queue name, this field contains that name.message_count (
typing.Optional
[int
]) – Number of messages in the queue.consumer_count (
typing.Optional
[int
]) – Number of consumers
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Bind
(ticket=0, queue='', exchange='', routing_key='', nowait=False, arguments=None)[source]¶ Bind queue to an exchange
This method binds a queue to an exchange. Until a queue is bound it will not receive any messages. In a classic messaging model, store-and- forward queues are bound to a direct exchange and subscription queues are bound to a topic exchange.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
queue (
str
) – Specifies the name of the queue to bind. - Default:''
exchange (
str
) – Name of the exchange to bind to - Default:''
routing_key (
str
) – Message routing key - Default:''
nowait (
bool
) – Do not send a reply method - Default:False
arguments (
Arguments
) – Arguments for binding - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Purge
(ticket=0, queue='', nowait=False)[source]¶ Purge a queue
This method removes all messages from a queue which are not awaiting acknowledgment.
- Parameters
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
PurgeOk
(message_count=None)[source]¶ Confirms a queue purge
This method confirms the purge of a queue.
- Parameters
message_count (
typing.Optional
[int
]) – Reports the number of messages purged.
- class
Delete
(ticket=0, queue='', if_unused=False, if_empty=False, nowait=False)[source]¶ Delete a queue
This method deletes a queue. When a queue is deleted any pending messages are sent to a dead-letter queue if this is defined in the server configuration, and all consumers on the queue are cancelled.
- Parameters
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
DeleteOk
(message_count=None)[source]¶ Confirm deletion of a queue
This method confirms the deletion of a queue.
- Parameters
message_count (
typing.Optional
[int
]) – Reports the number of messages deleted.
- class
Unbind
(ticket=0, queue='', exchange='', routing_key='', arguments=None)[source]¶ Unbind a queue from an exchange
This method unbinds a queue from an exchange.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
queue (
str
) – Specifies the name of the queue to unbind. - Default:''
exchange (
str
) – The name of the exchange to unbind from. - Default:''
routing_key (
str
) – Routing key of binding - Default:''
arguments (
Arguments
) – Arguments of binding - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
- class
pamqp.commands.
Basic
[source]¶ Work with basic content
The Basic class provides methods that support an industry-standard messaging model.
- class
Qos
(prefetch_size=0, prefetch_count=0, global_=False)[source]¶ Specify quality of service
This method requests a specific quality of service. The QoS can be specified for the current channel or for all channels on the connection. The particular properties and semantics of a qos method always depend on the content class semantics. Though the qos method could in principle apply to both peers, it is currently meaningful only for the server.
- class
QosOk
[source]¶ Confirm the requested qos
This method tells the client that the requested QoS levels could be handled by the server. The requested QoS applies to all active consumers until a new QoS is defined.
- class
Consume
(ticket=0, queue='', consumer_tag='', no_local=False, no_ack=False, exclusive=False, nowait=False, arguments=None)[source]¶ Start a queue consumer
This method asks the server to start a “consumer”, which is a transient request for messages from a specific queue. Consumers last as long as the channel they were declared on, or until the client cancels them.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
queue (
str
) – Specifies the name of the queue to consume from. - Default:''
consumer_tag (
str
) – Specifies the identifier for the consumer. The consumer tag is local to a channel, so two clients can use the same consumer tags. If this field is empty the server will generate a unique tag. - Default:''
no_local (
bool
) – Do not deliver own messages - Default:False
no_ack (
bool
) – No acknowledgement needed - Default:False
exclusive (
bool
) – Request exclusive access - Default:False
nowait (
bool
) – Do not send a reply method - Default:False
arguments (
Arguments
) – Arguments for declaration - Default:{}
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
ConsumeOk
(consumer_tag=None)[source]¶ Confirm a new consumer
The server provides the client with a consumer tag, which is used by the client for methods called on the consumer at a later stage.
- Parameters
consumer_tag (
typing.Optional
[str
]) – Holds the consumer tag specified by the client or provided by the server.
- class
Cancel
(consumer_tag=None, nowait=False)[source]¶ End a queue consumer
This method cancels a consumer. This does not affect already delivered messages, but it does mean the server will not send any more messages for that consumer. The client may receive an arbitrary number of messages in between sending the cancel method and receiving the cancel- ok reply. It may also be sent from the server to the client in the event of the consumer being unexpectedly cancelled (i.e. cancelled for any reason other than the server receiving the corresponding basic.cancel from the client). This allows clients to be notified of the loss of consumers due to events such as queue deletion. Note that as it is not a MUST for clients to accept this method from the server, it is advisable for the broker to be able to identify those clients that are capable of accepting the method, through some means of capability negotiation.
- Parameters
consumer_tag (
typing.Optional
[str
]) – Consumer tagnowait (
bool
) – Do not send a reply method - Default:False
- class
CancelOk
(consumer_tag=None)[source]¶ Confirm a cancelled consumer
This method confirms that the cancellation was completed.
- Parameters
consumer_tag (
typing.Optional
[str
]) – Consumer tag
- class
Publish
(ticket=0, exchange='', routing_key='', mandatory=False, immediate=False)[source]¶ Publish a message
This method publishes a message to a specific exchange. The message will be routed to queues as defined by the exchange configuration and distributed to any active consumers when the transaction, if any, is committed.
- Parameters
ticket (
int
) – Deprecated, must be0
- Default:0
exchange (
str
) – Specifies the name of the exchange to publish to. The exchange name can be empty, meaning the default exchange. If the exchange name is specified, and that exchange does not exist, the server will raise a channel exception. - Default:''
routing_key (
str
) – Message routing key - Default:''
mandatory (
bool
) – Indicate mandatory routing - Default:False
immediate (
bool
) – Request immediate delivery - Default:False
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Return
(reply_code=None, reply_text='', exchange='', routing_key=None)[source]¶ Return a failed message
This method returns an undeliverable message that was published with the “immediate” flag set, or an unroutable message published with the “mandatory” flag set. The reply code and text provide information about the reason that the message was undeliverable.
- Parameters
reply_code (
typing.Optional
[int
]) – Reply code from serverreply_text (
str
) – Localised reply text - Default:''
exchange (
str
) – Specifies the name of the exchange that the message was originally published to. May be empty, meaning the default exchange. - Default:''
routing_key (
typing.Optional
[str
]) – Message routing key
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Deliver
(consumer_tag=None, delivery_tag=None, redelivered=False, exchange='', routing_key=None)[source]¶ Notify the client of a consumer message
This method delivers a message to the client, via a consumer. In the asynchronous message delivery model, the client starts a consumer using the Consume method, then the server responds with Deliver methods as and when messages arrive for that consumer.
- Parameters
consumer_tag (
typing.Optional
[str
]) – Consumer tagdelivery_tag (
typing.Optional
[int
]) – Server-assigned delivery tagredelivered (
bool
) – Message is being redelivered - Default:False
exchange (
str
) – Specifies the name of the exchange that the message was originally published to. May be empty, indicating the default exchange. - Default:''
routing_key (
typing.Optional
[str
]) – Message routing key
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Get
(ticket=0, queue='', no_ack=False)[source]¶ Direct access to a queue
This method provides a direct access to the messages in a queue using a synchronous dialogue that is designed for specific types of application where synchronous functionality is more important than performance.
- Parameters
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
GetOk
(delivery_tag=None, redelivered=False, exchange='', routing_key=None, message_count=None)[source]¶ Provide client with a message
This method delivers a message to the client following a get method. A message delivered by ‘get-ok’ must be acknowledged unless the no-ack option was set in the get method.
- Parameters
delivery_tag (
typing.Optional
[int
]) – Server-assigned delivery tagredelivered (
bool
) – Message is being redelivered - Default:False
exchange (
str
) – Specifies the name of the exchange that the message was originally published to. If empty, the message was published to the default exchange. - Default:''
routing_key (
typing.Optional
[str
]) – Message routing keymessage_count (
typing.Optional
[int
]) – Number of messages in the queue.
- Raises
ValueError – when an argument fails to validate
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
GetEmpty
(cluster_id='')[source]¶ Indicate no messages available
This method tells the client that the queue has no messages available for the client.
- Parameters
cluster_id (
str
) – Deprecated, must be empty - Default:''
-
validate
()[source]¶ Validate the frame data ensuring all domains or attributes adhere to the protocol specification.
- Raises
ValueError – on validation error
- Return type
None
- class
Ack
(delivery_tag=0, multiple=False)[source]¶ Acknowledge one or more messages
When sent by the client, this method acknowledges one or more messages delivered via the Deliver or Get-Ok methods. When sent by server, this method acknowledges one or more messages published with the Publish method on a channel in confirm mode. The acknowledgement can be for a single message or a set of messages up to and including a specific message.
- class
Reject
(delivery_tag=None, requeue=True)[source]¶ Reject an incoming message
This method allows a client to reject a message. It can be used to interrupt and cancel large incoming messages, or return untreatable messages to their original queue.
- Parameters
delivery_tag (
typing.Optional
[int
]) – Server-assigned delivery tagrequeue (
bool
) – Requeue the message - Default:True
- class
RecoverAsync
(requeue=False)[source]¶ Redeliver unacknowledged messages
This method asks the server to redeliver all unacknowledged messages on a specified channel. Zero or more messages may be redelivered. This method is deprecated in favour of the synchronous Recover/Recover-Ok.
Deprecated since version This: command is deprecated in AMQP 0-9-1
- Parameters
requeue (
bool
) – Requeue the message - Default:False
- class
Recover
(requeue=False)[source]¶ Redeliver unacknowledged messages
This method asks the server to redeliver all unacknowledged messages on a specified channel. Zero or more messages may be redelivered. This method replaces the asynchronous Recover.
- Parameters
requeue (
bool
) – Requeue the message - Default:False
- class
RecoverOk
[source]¶ Confirm recovery
This method acknowledges a
Basic.Recover
method.
- class
Nack
(delivery_tag=0, multiple=False, requeue=True)[source]¶ Reject one or more incoming messages
This method allows a client to reject one or more incoming messages. It can be used to interrupt and cancel large incoming messages, or return untreatable messages to their original queue. This method is also used by the server to inform publishers on channels in confirm mode of unhandled messages. If a publisher receives this method, it probably needs to republish the offending messages.
- class
Properties
(content_type=None, content_encoding=None, headers=None, delivery_mode=None, priority=None, correlation_id=None, reply_to=None, expiration=None, message_id=None, timestamp=None, message_type=None, user_id=None, app_id=None, cluster_id='')[source]¶ Content Properties
Note
The AMQP property type is named
message_type
as to not conflict with the Pythontype
keyword- Parameters
content_type (
typing.Optional
[str
]) – MIME content typecontent_encoding (
typing.Optional
[str
]) – MIME content encodingheaders (typing.Optional[
FieldTable
]) – Message header field tabledelivery_mode (
typing.Optional
[int
]) – Non-persistent (1) or persistent (2)priority (
typing.Optional
[int
]) – Message priority, 0 to 9correlation_id (
typing.Optional
[str
]) – Application correlation identifierreply_to (
typing.Optional
[str
]) – Address to reply toexpiration (
typing.Optional
[str
]) – Message expiration specificationmessage_id (
typing.Optional
[str
]) – Application message identifiertimestamp (
typing.Optional
[datetime.datetime
]) – Message timestampmessage_type (
typing.Optional
[str
]) – Message type nameuser_id (
typing.Optional
[str
]) – Creating user idapp_id (
typing.Optional
[str
]) – Creating application idcluster_id (
str
) – Deprecated, must be empty
- Raises
ValueError
- class
- class
pamqp.commands.
Tx
[source]¶ Work with transactions
The Tx class allows publish and ack operations to be batched into atomic units of work. The intention is that all publish and ack requests issued within a transaction will complete successfully or none of them will. Servers SHOULD implement atomic transactions at least where all publish or ack requests affect a single queue. Transactions that cover multiple queues may be non-atomic, given that queues can be created and destroyed asynchronously, and such events do not form part of any transaction. Further, the behaviour of transactions with respect to the immediate and mandatory flags on
Basic.Publish
methods is not defined.- class
Select
[source]¶ Select standard transaction mode
This method sets the channel to use standard transactions. The client must use this method at least once on a channel before using the Commit or Rollback methods.
- class
SelectOk
[source]¶ Confirm transaction mode
This method confirms to the client that the channel was successfully set to use standard transactions.
- class
Commit
[source]¶ Commit the current transaction
This method commits all message publications and acknowledgments performed in the current transaction. A new transaction starts immediately after a commit.
- class
CommitOk
[source]¶ Confirm a successful commit
This method confirms to the client that the commit succeeded. Note that if a commit fails, the server raises a channel exception.
- class
Rollback
[source]¶ Abandon the current transaction
This method abandons all message publications and acknowledgments performed in the current transaction. A new transaction starts immediately after a rollback. Note that unacked messages will not be automatically redelivered by rollback; if that is required an explicit recover call should be issued.
- class
- class
pamqp.commands.
Confirm
[source]¶ Work with confirms
The Confirm class allows publishers to put the channel in confirm mode and subsequently be notified when messages have been handled by the broker. The intention is that all messages published on a channel in confirm mode will be acknowledged at some point. By acknowledging a message the broker assumes responsibility for it and indicates that it has done something it deems reasonable with it. Unroutable mandatory or immediate messages are acknowledged right after the
Basic.Return
method. Messages are acknowledged when all queues to which the message has been routed have either delivered the message and received an acknowledgement (if required), or enqueued the message (and persisted it if required). Published messages are assigned ascending sequence numbers, starting at 1 with the firstConfirm.Select
method. The server confirms messages by sendingBasic.Ack
methods referring to these sequence numbers.