File: //usr/local/lib/python3.9/site-packages/amqp/__pycache__/channel.cpython-39.pyc
a
X>h�" � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZ ddl m
Z
ddl m Z dd l
mZmZmZmZmZmZ dd
lmZ d Ze�d �Zd
ZG dd� de�ZG dd� de �Z dS )zAMQP Channels.� N)� defaultdict)�Queue)�ensure_promise� )�spec)�AbstractChannel)� ChannelError�ConsumerCancelled�
MessageNacked�RecoverableChannelError�RecoverableConnectionError�error_for_code)�queue_declare_ok_t)�ChannelZamqpzuRejecting message with delivery tag %r for reason of having no callbacks.
consumer_tag=%r exchange=%r routing_key=%r.c @ s e Zd ZdS )�VDeprecationWarningN)�__name__�
__module__� __qualname__� r r �6/usr/local/lib/python3.9/site-packages/amqp/channel.pyr s r c sZ e Zd ZdZe�ejjd�e�ejj�e�ejj d�e�ejj
d�e�ejj �e�ej j
�e�ej j�e�ej j�e�ej j�e�ejj�e�ejj�e�ejj
d�e�ejjd�e�ejjd�e�ejjd�e�ejjd�e�ejjd�ejejjddd �e�ejjd�ejejjd
dd �e�ejj�e�ejj�ejejj d dd �e�ej j �e�ej j �e�ej j �e�ej!j �e�ejj"d �e�ejj#d �h Z$d
d� e$D �Z$ejjejjfZ%dy� fdd� Z&dzdd�Z'dd� Z(dd� Z)dd� Z*d{d d �Z+d d � Z,d!d"� Z-d#d$� Z.d%d&� Z/d'd(� Z0d)d*� Z1d+d,� Z2d|d/d0�Z3d}d2d3�Z4d~d5d6�Z5dd7d8�Z6d�d9d:�Z7d�d<d=�Z8d�d?d@�Z9d�dBdC�Z:d�dEdF�Z;d�dGdH�Z<d�dJdK�Z=dLdM� Z>dNdO� Z?dPdQ� Z@d�dSdT�ZAdUdV� ZBd�dWdX�ZCd�dYdZ�ZDd[d\� ZEd�d^d_�ZFeFZGd`da� ZHd�dcdd�ZId�dedf�ZJd�dgdh�ZKd�didj�ZLdkdl� ZMdmdn� ZNdodp� ZOdqdr� ZPd�dsdt�ZQdudv� ZRdwdx� ZS� ZTS )�r a AMQP Channel.
The channel class provides methods for a client to establish a
virtual connection - a channel - to a server and for both peers to
operate the virtual connection thereafter.
GRAMMAR::
channel = open-channel *use-channel close-channel
open-channel = C:OPEN S:OPEN-OK
use-channel = C:FLOW S:FLOW-OK
/ S:FLOW C:FLOW-OK
/ functional-class
close-channel = C:CLOSE S:CLOSE-OK
/ S:CLOSE C:CLOSE-OK
Create a channel bound to a connection and using the specified
numeric channel_id, and open on the server.
The 'auto_decode' parameter (defaults to True), indicates
whether the library should attempt to decode the body
of Messages to a Unicode string if there's a 'content_encoding'
property for the message. If there's no 'content_encoding'
property, or the decode raises an Exception, the message body
is left as plain bytes.
�BsBB�bZsll�l�sZsLbssT)�contentZLbsslZBsss�Lbc C s i | ] }|j |�qS r )�
method_sig)�.0�mr r r �
<dictcomp>[ � zChannel.<dictcomp>Nc s� |r|� |� n|�� }t�d|� t� �||� d| _d| _t� | _ i | _
i | _ || _ t
t�| _t� | _t|�| _d| _| jjr�| j| _d}d S )Nzusing channel_id: %sFT) �is_open�active�returned_messages� callbacks�cancel_callbacks�events�no_ack_consumers�on_open�_confirm_selected)Z_claim_channel_idZ_get_free_channel_id� AMQP_LOGGER�debug�super�__init__r! r" r r# r$ r% � auto_decoder �setr& r' r r( r) �
connectionZconfirm_publish�basic_publish_confirm�
basic_publish)�selfr0 �
channel_idr. r( � __slots__�� __class__r r r- a s$
zChannel.__init__c C s | j �||�S �N)r( �then)r3 Z
on_successZon_errorr r r r9 � s z Channel.thenc C st | j �tjj| jtjj| jtjj| j tjj
| j tj j
| jtj j| jtj j| jtj j| jtj j| jtj j| ji
� d S r8 )�
_callbacks�updater r �Close� _on_close�CloseOk� _on_close_ok�Flow�_on_flow�OpenOk� _on_open_ok�Basic�Cancel�_on_basic_cancel�CancelOk�_on_basic_cancel_ok�Deliver�_on_basic_deliver�Return�_on_basic_return�Ack�
_on_basic_ack�Nack�_on_basic_nack�r3 r r r �_setup_listeners� s
�zChannel._setup_listenersc C s� t �d| j� d| _| jd }| _| jd }| _|rf|j�|d� z|j�|� W n t yd Y n0 | j
� � | j � � | j
� � | j� � dS )zaTear down this object.
Best called after we've agreed to close with the server.
zClosed channel #%sFN)r* r+ r4 r! r0 �channels�popZ_used_channel_ids�remove�
ValueErrorr$ �clearr% r& r' )r3 r4 r0 r r r �collect� s
zChannel.collectc C s d| _ | �� d S )NF)r! �openrQ r r r �
_do_revive� s zChannel._do_reviver � �r r c C s� z�| j du r W d| _d| _ dS | j jdu r<W d| _d| _ dS | jsTW d| _d| _ dS d| _| jtjj||||d |d ftjjd�W d| _d| _ S d| _d| _ 0 dS )�e 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.
RULE:
After sending this method any received method except
Channel.Close-OK MUST be discarded.
RULE:
The peer sending this method MAY use a counter or timeout
to detect failure of the other peer to respond correctly
with Channel.Close-OK..
PARAMETERS:
reply_code: short
The reply code. The AMQ reply codes are defined in AMQ
RFC 011.
reply_text: shortstr
The localised reply text. This text can be logged as an
aid to resolving issues.
class_id: short
failing method class
When the close is provoked by a method exception, this
is the class of the method.
method_id: short
failing method ID
When the close is provoked by a method exception, this
is the ID of the method.
NFTr r ��wait) r0 �
is_closingrS r! � send_methodr r r< r> )r3 �
reply_code�
reply_textr �argsigr r r �close� s: /
� � ��� �z
Channel.closec C s4 | � tjj� | jjs0| �� t||||ft��dS )r] N) ra r r r> r0 r` rZ r
r )r3 rb rc Zclass_idZ method_idr r r r= � s . �zChannel._on_closec C s | � � dS )at 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
and close the socket.
RULE:
A peer that detects a socket closure without having
received a Channel.Close-Ok handshake method SHOULD log
the error.
N)rX rQ r r r r? ) s
zChannel._on_close_okc C s | j tjjd|ftjjd�S )�O Enable/disable flow from peer.
This method asks the peer to pause or restart the flow of
content data. 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. The
peer that receives a request to stop sending content should
finish sending the current content, if any, and then wait
until it receives a Flow restart method.
RULE:
When a new channel is opened, it is active. Some
applications assume that channels are inactive until
started. To emulate this behaviour a client MAY open the
channel, then pause it.
RULE:
When sending content data in multiple frames, a peer
SHOULD monitor the channel for incoming methods and
respond to a Channel.Flow as rapidly as possible.
RULE:
A peer MAY use the Channel.Flow method to throttle
incoming content data for internal reasons, for example,
when exchanging data over a slower connection.
RULE:
The peer that requests a Channel.Flow method MAY
disconnect and/or ban a peer that does not respect the
request.
PARAMETERS:
active: boolean
start/stop content frames
If True, the peer starts sending content frames. If
False, the peer stops sending content frames.
r r^ )ra r r r@ �FlowOk�r3 r" r r r �flow8 s -�z Channel.flowc C s || _ | �| j � dS )rf N)r" �
_x_flow_okrh r r r rA i s -zChannel._on_flowc C s | � tjjd|f�S )a� Confirm a flow method.
Confirms to the peer that a flow command was received and
processed.
PARAMETERS:
active: boolean
current flow setting
Confirms the setting of the processed flow method:
True means the peer will start sending or continue
to send content frames; False means it will not.
r )ra r r rg rh r r r rj � s zChannel._x_flow_okc C s$ | j r
dS | jtjjddtjjd�S )a� Open a channel for use.
This method opens a virtual connection (a channel).
RULE:
This method MUST NOT be called when the channel is already
open.
PARAMETERS:
out_of_band: shortstr (DEPRECATED)
out-of-band settings
Configures out-of-band transfers on this channel. The
syntax and meaning of this field will be formally
defined at a later date.
Nr )r[ r^ )r! ra r r ZOpenrB rQ r r r rY � s
�z Channel.openc C s d| _ | �| � t�d� dS )z�Signal that the channel is ready.
This method signals to the client that the channel is ready
for use.
Tz Channel openN)r! r( r* r+ rQ r r r rC � s
zChannel._on_open_okF� BssbbbbbFc C s8 | j tjj|d|||||d||f |r(dntjjd� dS )a� Declare exchange, 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.
RULE:
The server SHOULD support a minimum of 16 exchanges per
virtual host and ideally, impose no limit except as
defined by available resources.
PARAMETERS:
exchange: shortstr
RULE:
Exchange names starting with "amq." are reserved
for predeclared and standardised exchanges. If
the client attempts to create an exchange starting
with "amq.", the server MUST raise a channel
exception with reply code 403 (access refused).
type: shortstr
exchange type
Each exchange belongs to one of a set of exchange
types implemented by the server. The exchange types
define the functionality of the exchange - i.e. how
messages are routed through it. It is not valid or
meaningful to attempt to change the type of an
existing exchange.
RULE:
If the exchange already exists with a different
type, the server MUST raise a connection exception
with a reply code 507 (not allowed).
RULE:
If the server does not support the requested
exchange type it MUST raise a connection exception
with a reply code 503 (command invalid).
passive: boolean
do not create exchange
If set, the server will not create the exchange. The
client can use this to check whether an exchange
exists without modifying the server state.
RULE:
If set, and the exchange does not already exist,
the server MUST raise a channel exception with
reply code 404 (not found).
durable: boolean
request a durable exchange
If set when creating a new exchange, the exchange will
be marked as durable. Durable exchanges remain active
when a server restarts. Non-durable exchanges
(transient exchanges) are purged if/when a server
restarts.
RULE:
The server MUST support both durable and transient
exchanges.
RULE:
The server MUST ignore the durable field if the
exchange already exists.
auto_delete: boolean
auto-delete when unused
If set, the exchange is deleted when all queues have
finished using it.
RULE:
The server SHOULD allow for a reasonable delay
between the point when it determines that an
exchange is not being used (or no longer used),
and the point when it deletes the exchange. At
the least it must allow a client to create an
exchange and then bind a queue to it, with a small
but non-zero delay between these two actions.
RULE:
The server MUST ignore the auto-delete field if
the exchange already exists.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
arguments: table
arguments for declaration
A set of arguments for the declaration. The syntax and
semantics of these arguments depends on the server
implementation. This field is ignored if passive is
True.
r FNr^ )ra r �Exchange�Declare� DeclareOk) r3 �exchange�type�passive�durable� auto_delete�nowait� argumentsrd r r r �exchange_declare� s { ��zChannel.exchange_declare�Bsbbc C s* | j tjj|d|||f|r dntjjd�S )a Delete an exchange.
This method deletes an exchange. When an exchange is deleted
all queue bindings on the exchange are cancelled.
PARAMETERS:
exchange: shortstr
RULE:
The exchange MUST exist. Attempting to delete a
non-existing exchange causes a channel exception.
if_unused: boolean
delete only if unused
If set, the server will only delete the exchange if it
has no queue bindings. If the exchange has queue
bindings the server does not delete it but raises a
channel exception instead.
RULE:
If set, the server SHOULD delete the exchange but
only if it has no queue bindings.
RULE:
If set, the server SHOULD raise a channel
exception if the exchange is in use.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
r Nr^ )ra r rl �Delete�DeleteOk)r3 ro � if_unusedrt rd r r r �exchange_deletew s +�zChannel.exchange_delete�BsssbFc C s. | j tjj|d|||||f|r"dntjjd�S )a Bind an exchange to an exchange.
RULE:
A server MUST allow and ignore duplicate bindings - that
is, two or more bind methods for a specific exchanges,
with identical arguments - without treating these as an
error.
RULE:
A server MUST allow cycles of exchange bindings to be
created including allowing an exchange to be bound to
itself.
RULE:
A server MUST not deliver the same message more than once
to a destination exchange, even if the topology of
exchanges and bindings results in multiple (even infinite)
routes to that exchange.
PARAMETERS:
reserved-1: short
destination: shortstr
Specifies the name of the destination exchange to
bind.
RULE:
A client MUST NOT be allowed to bind a non-
existent destination exchange.
RULE:
The server MUST accept a blank exchange name to
mean the default exchange.
source: shortstr
Specifies the name of the source exchange to bind.
RULE:
A client MUST NOT be allowed to bind a non-
existent source exchange.
RULE:
The server MUST accept a blank exchange name to
mean the default exchange.
routing-key: shortstr
Specifies the routing key for the binding. The routing
key is used for routing messages depending on the
exchange configuration. Not all exchanges use a
routing key - refer to the specific exchange
documentation.
no-wait: bit
arguments: table
A set of arguments for the binding. The syntax and
semantics of these arguments depends on the exchange
class.
r Nr^ )ra r rl �Bind�BindOk�r3 � destination�source� routing_keyrt ru rd r r r �
exchange_bind� s
H�zChannel.exchange_bindc C s. | j tjj|d|||||f|r"dntjjd�S )a� Unbind an exchange from an exchange.
RULE:
If a unbind fails, the server MUST raise a connection
exception.
PARAMETERS:
reserved-1: short
destination: shortstr
Specifies the name of the destination exchange to
unbind.
RULE:
The client MUST NOT attempt to unbind an exchange
that does not exist from an exchange.
RULE:
The server MUST accept a blank exchange name to
mean the default exchange.
source: shortstr
Specifies the name of the source exchange to unbind.
RULE:
The client MUST NOT attempt to unbind an exchange
from an exchange that does not exist.
RULE:
The server MUST accept a blank exchange name to
mean the default exchange.
routing-key: shortstr
Specifies the routing key of the binding to unbind.
no-wait: bit
arguments: table
Specifies the arguments of the binding to unbind.
r Nr^ )ra r rl �Unbind�UnbindOkr r r r �exchange_unbind� s
3�zChannel.exchange_unbindc C s. | j tjj|d|||||f|r"dntjjd�S )a� 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 dest
exchange and subscription queues are bound to a dest_wild
exchange.
RULE:
A server MUST allow ignore duplicate bindings - that is,
two or more bind methods for a specific queue, with
identical arguments - without treating these as an error.
RULE:
If a bind fails, the server MUST raise a connection
exception.
RULE:
The server MUST NOT allow a durable queue to bind to a
transient exchange. If the client attempts this the server
MUST raise a channel exception.
RULE:
Bindings for durable queues are automatically durable and
the server SHOULD restore such bindings after a server
restart.
RULE:
The server SHOULD support at least 4 bindings per queue,
and ideally, impose no limit except as defined by
available resources.
PARAMETERS:
queue: shortstr
Specifies the name of the queue to bind. If the queue
name is empty, refers to the current queue for the
channel, which is the last declared queue.
RULE:
If the client did not previously declare a queue,
and the queue name in this method is empty, the
server MUST raise a connection exception with
reply code 530 (not allowed).
RULE:
If the queue does not exist the server MUST raise
a channel exception with reply code 404 (not
found).
exchange: shortstr
The name of the exchange to bind to.
RULE:
If the exchange does not exist the server MUST
raise a channel exception with reply code 404 (not
found).
routing_key: shortstr
message routing key
Specifies the routing key for the binding. The
routing key is used for routing messages depending on
the exchange configuration. Not all exchanges use a
routing key - refer to the specific exchange
documentation. If the routing key is empty and the
queue name is empty, the routing key will be the
current queue for the channel, which is the last
declared queue.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
arguments: table
arguments for binding
A set of arguments for the binding. The syntax and
semantics of these arguments depends on the exchange
class.
r Nr^ )ra r r r} r~ �r3 �queuero r� rt ru rd r r r �
queue_bindH s
c�zChannel.queue_bind�BsssFc C s, | j tjj|d||||f|r dntjjd�S )a� Unbind a queue from an exchange.
This method unbinds a queue from an exchange.
RULE:
If a unbind fails, the server MUST raise a connection exception.
PARAMETERS:
queue: shortstr
Specifies the name of the queue to unbind.
RULE:
The client MUST either specify a queue name or have
previously declared a queue on the same channel
RULE:
The client MUST NOT attempt to unbind a queue that
does not exist.
exchange: shortstr
The name of the exchange to unbind from.
RULE:
The client MUST NOT attempt to unbind a queue from an
exchange that does not exist.
RULE:
The server MUST accept a blank exchange name to mean
the default exchange.
routing_key: shortstr
routing key of binding
Specifies the routing key of the binding to unbind.
arguments: table
arguments of binding
Specifies the arguments of the binding to unbind.
r Nr^ )ra r r r� r� r� r r r � queue_unbind� s
3 �zChannel.queue_unbind�BsbbbbbFc C s@ | � tjj|d|||||||f� |s<t| jtjjdd�� S dS )a� 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.
RULE:
The server MUST create a default binding for a newly-
created queue to the default exchange, which is an
exchange of type 'direct'.
RULE:
The server SHOULD support a minimum of 256 queues per
virtual host and ideally, impose no limit except as
defined by available resources.
PARAMETERS:
queue: shortstr
RULE:
The queue name MAY be empty, in which case the
server MUST create a new queue with a unique
generated name and return this to the client in
the Declare-Ok method.
RULE:
Queue names starting with "amq." are reserved for
predeclared and standardised server queues. If
the queue name starts with "amq." and the passive
option is False, the server MUST raise a connection
exception with reply code 403 (access refused).
passive: boolean
do not create queue
If set, the server will not create the queue. The
client can use this to check whether a queue exists
without modifying the server state.
RULE:
If set, and the queue does not already exist, the
server MUST respond with a reply code 404 (not
found) and raise a channel exception.
durable: boolean
request a durable queue
If set when creating a new queue, the queue will be
marked as durable. Durable queues remain active when
a server restarts. Non-durable queues (transient
queues) are purged if/when a server restarts. Note
that durable queues do not necessarily hold persistent
messages, although it does not make sense to send
persistent messages to a transient queue.
RULE:
The server MUST recreate the durable queue after a
restart.
RULE:
The server MUST support both durable and transient
queues.
RULE:
The server MUST ignore the durable field if the
queue already exists.
exclusive: boolean
request an exclusive queue
Exclusive queues may only be consumed from by the
current connection. Setting the 'exclusive' flag
always implies 'auto-delete'.
RULE:
The server MUST support both exclusive (private)
and non-exclusive (shared) queues.
RULE:
The server MUST raise a channel exception if
'exclusive' is specified and the queue already
exists and is owned by a different connection.
auto_delete: boolean
auto-delete queue when unused
If set, the queue is deleted when all consumers have
finished using it. Last consumer can be cancelled
either explicitly or because its channel is closed. If
there was no consumer ever on the queue, it won't be
deleted.
RULE:
The server SHOULD allow for a reasonable delay
between the point when it determines that a queue
is not being used (or no longer used), and the
point when it deletes the queue. At the least it
must allow a client to create a queue and then
create a consumer to read from it, with a small
but non-zero delay between these two actions. The
server should equally allow for clients that may
be disconnected prematurely, and wish to re-
consume from the same queue without losing
messages. We would recommend a configurable
timeout, with a suitable default value being one
minute.
RULE:
The server MUST ignore the auto-delete field if
the queue already exists.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
arguments: table
arguments for declaration
A set of arguments for the declaration. The syntax and
semantics of these arguments depends on the server
implementation. This field is ignored if passive is
True.
Returns a tuple containing 3 items:
the name of the queue (essential for automatically-named queues),
message count and
consumer count
r T)�
returns_tupleN)ra r r rm r r_ rn ) r3 r� rq rr � exclusivers rt ru rd r r r �
queue_declare� s ���zChannel.queue_declare�Bsbbbc C s, | j tjj|d||||f|r dntjjd�S )a� 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.
RULE:
The server SHOULD use a dead-letter queue to hold messages
that were pending on a deleted queue, and MAY provide
facilities for a system administrator to move these
messages back to an active queue.
PARAMETERS:
queue: shortstr
Specifies the name of the queue to delete. If the
queue name is empty, refers to the current queue for
the channel, which is the last declared queue.
RULE:
If the client did not previously declare a queue,
and the queue name in this method is empty, the
server MUST raise a connection exception with
reply code 530 (not allowed).
RULE:
The queue must exist. Attempting to delete a non-
existing queue causes a channel exception.
if_unused: boolean
delete only if unused
If set, the server will only delete the queue if it
has no consumers. If the queue has consumers the
server does does not delete it but raises a channel
exception instead.
RULE:
The server MUST respect the if-unused flag when
deleting a queue.
if_empty: boolean
delete only if empty
If set, the server will only delete the queue if it
has no messages. If the queue is not empty the server
raises a channel exception.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
If nowait is False, returns the number of deleted messages.
r Nr^ )ra r r rx ry )r3 r� rz Zif_emptyrt rd r r r � queue_delete� s
E �zChannel.queue_delete�Bsbc C s( | j tjj|d||f|r dntjjd�S )aK Purge a queue.
This method removes all messages from a queue. It does not
cancel consumers. Purged messages are deleted without any
formal "undo" mechanism.
RULE:
A call to purge MUST result in an empty queue.
RULE:
On transacted channels the server MUST not purge messages
that have already been sent to a client but not yet
acknowledged.
RULE:
The server MAY implement a purge queue or log that allows
system administrators to recover accidentally-purged
messages. The server SHOULD NOT keep purged messages in
the same storage spaces as the live messages since the
volumes of purged messages may get very large.
PARAMETERS:
queue: shortstr
Specifies the name of the queue to purge. If the
queue name is empty, refers to the current queue for
the channel, which is the last declared queue.
RULE:
If the client did not previously declare a queue,
and the queue name in this method is empty, the
server MUST raise a connection exception with
reply code 530 (not allowed).
RULE:
The queue must exist. Attempting to purge a non-
existing queue causes a channel exception.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
If nowait is False, returns a number of purged messages.
r Nr^ )ra r r ZPurge�PurgeOk)r3 r� rt rd r r r � queue_purge� s 7�zChannel.queue_purgec C s | � tjj|||f�S )a� Acknowledge one or more messages.
This method acknowledges one or more messages delivered via
the Deliver or Get-Ok methods. The client can ask to confirm
a single message or a set of messages up to and including a
specific message.
PARAMETERS:
delivery_tag: longlong
server-assigned delivery tag
The server-assigned and channel-specific delivery tag
RULE:
The delivery tag is valid only within the channel
from which the message was received. I.e. a client
MUST NOT receive a message on one channel and then
acknowledge it on another.
RULE:
The server MUST NOT use a zero value for delivery
tags. Zero is reserved for client use, meaning "all
messages so far received".
multiple: boolean
acknowledge multiple messages
If set to True, the delivery tag is treated as "up to
and including", so that the client can acknowledge
multiple messages with a single method. If set to
False, the delivery tag refers to a single message.
If the multiple field is True, and the delivery tag
is zero, tells the server to acknowledge all
outstanding messages.
RULE:
The server MUST validate that a non-zero delivery-
tag refers to an delivered message, and raise a
channel exception if this is not the case.
)ra r rD rM )r3 � delivery_tag�multiplerd r r r � basic_ackQ s .�zChannel.basic_ack�sbc C s@ | j dur<| j�|� | jtjj|||f|r0dntjjd�S dS )aI 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.
RULE:
If the queue no longer exists when the client sends a
cancel command, or the consumer has been cancelled for
other reasons, this command has no effect.
PARAMETERS:
consumer_tag: shortstr
consumer tag
Identifier for the consumer, valid within the current
connection.
RULE:
The consumer tag is valid only within the channel
from which the consumer was created. I.e. a client
MUST NOT create a consumer in one channel and then
use it in another.
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
Nr^ )r0 r' �discardra r rD rE rG )r3 � consumer_tagrt rd r r r � basic_cancel� s '
�zChannel.basic_cancelc C s* | � |�}|r||� nt|tjj��dS )zSConsumer cancelled by server.
Most likely the queue was deleted.
N)� _remove_tagr r rD rE )r3 r� �callbackr r r rF � s
zChannel._on_basic_cancelc C s | � |� d S r8 )r� �r3 r� r r r rH � s zChannel._on_basic_cancel_okc C s | j �|d � | j�|d �S r8 )r$ rT r% r� r r r r� � s zChannel._remove_tag�BssbbbbFc C s� | j tjj|
d|||||||f|r&dntjjdd�} |sB| d }n|rR|sRtd��|| j|< | rj| | j|< |rz| j� |� |s�|S | S dS )a= 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 created on, or
until the client cancels them.
RULE:
The server SHOULD support at least 16 consumers per queue,
unless the queue was declared as private, and ideally,
impose no limit except as defined by available resources.
PARAMETERS:
queue: shortstr
Specifies the name of the queue to consume from. If
the queue name is null, refers to the current queue
for the channel, which is the last declared queue.
RULE:
If the client did not previously declare a queue,
and the queue name in this method is empty, the
server MUST raise a connection exception with
reply code 530 (not allowed).
consumer_tag: shortstr
Specifies the identifier for the consumer. The
consumer tag is local to a connection, so two clients
can use the same consumer tags. If this field is empty
the server will generate a unique tag.
RULE:
The tag MUST NOT refer to an existing consumer. If
the client attempts to create two consumers with
the same non-empty tag the server MUST raise a
connection exception with reply code 530 (not
allowed).
no_local: boolean
do not deliver own messages
If the no-local field is set the server will not send
messages to the client that published them.
no_ack: boolean
no acknowledgment needed
If this field is set the server does not expect
acknowledgments for messages. That is, when a message
is delivered to the client the server automatically and
silently acknowledges it on behalf of the client. This
functionality increases performance but at the cost of
reliability. Messages can get lost if a client dies
before it can deliver them to the application.
exclusive: boolean
request exclusive access
Request exclusive consumer access, meaning only this
consumer can access the queue.
RULE:
If the server cannot grant exclusive access to the
queue when asked, - because there are other
consumers active - it MUST raise a channel
exception with return code 403 (access refused).
nowait: boolean
do not send a reply method
If set, the server will not respond to the method. The
client should not wait for a reply method. If the
server could not complete the method it will raise a
channel or connection exception.
callback: Python callable
function/method called with each delivered message
For each message delivered by the broker, the
callable will be called with a Message object
as the single argument. If no callable is specified,
messages are quietly discarded, no_ack should probably
be set to True in that case.
r NT�r_ r� z2Consumer tag must be specified when nowait is True)
ra r rD ZConsume� ConsumeOkrV r$ r% r' �add) r3 r� r� Zno_local�no_ackr� rt r� ru Z on_cancelrd �pr r r �
basic_consume� s, b ��
�
zChannel.basic_consumec
C sf | |_ |||||d�|_z| j| }W n2 tyX t�t||||� | j|dd� Y n
0 ||� d S )N)r� r� � redeliveredro r� T)�requeue)�channel�
delivery_infor$ �KeyErrorr* �warning�!REJECTED_MESSAGE_WITHOUT_CALLBACK� basic_reject)r3 r� r� r� ro r� �msgZfunr r r rJ I s � �zChannel._on_basic_deliverc C sN | j tjj|d||ftjjtjjgdd�}|r:t|�dk rD| j|� S | j|� S )a� 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:
queue: shortstr
Specifies the name of the queue to consume from. If
the queue name is null, refers to the current queue
for the channel, which is the last declared queue.
RULE:
If the client did not previously declare a queue,
and the queue name in this method is empty, the
server MUST raise a connection exception with
reply code 530 (not allowed).
no_ack: boolean
no acknowledgment needed
If this field is set the server does not expect
acknowledgments for messages. That is, when a message
is delivered to the client the server automatically and
silently acknowledges it on behalf of the client. This
functionality increases performance but at the cost of
reliability. Messages can get lost if a client dies
before it can deliver them to the application.
Non-blocking, returns a amqp.basic_message.Message object,
or None if queue is empty.
r Tr� � ) ra r rD ZGet�GetOk�GetEmpty�len�
_on_get_empty�
_on_get_ok)r3 r� r� rd �retr r r � basic_get_ s %�
zChannel.basic_getc C s d S r8 r )r3 Z
cluster_idr r r r� � s zChannel._on_get_emptyc C s | |_ |||||d�|_|S )N)r� r� ro r� �
message_count)r� r� )r3 r� r� ro r� r� r� r r r r� � s �zChannel._on_get_ok�Bssbbc
C s� | j std��| j j�di �} | �dd�rRz| j jdd� W n tjyP Y n0 zR| j j�|��0 | � t
j j |d||||f|�W d � W S 1 s�0 Y W n tjy� t
d��Y n0 dS ) a 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.
When channel is in confirm mode (when Connection parameter
confirm_publish is set to True), each message is confirmed.
When broker rejects published message (e.g. due internal broker
constrains), MessageNacked exception is raised and
set confirm_timeout to wait maximum confirm_timeout second
for message to confirm.
PARAMETERS:
exchange: shortstr
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.
RULE:
The server MUST accept a blank exchange name to
mean the default exchange.
RULE:
The exchange MAY refuse basic content in which
case it MUST raise a channel exception with reply
code 540 (not implemented).
routing_key: shortstr
Message routing key
Specifies the routing key for the message. The
routing key is used for routing messages depending on
the exchange configuration.
mandatory: boolean
indicate mandatory routing
This flag tells the server how to react if the message
cannot be routed to a queue. If this flag is True, the
server will return an unroutable message with a Return
method. If this flag is False, the server silently
drops the message.
RULE:
The server SHOULD implement the mandatory flag.
immediate: boolean
request immediate delivery
This flag tells the server how to react if the message
cannot be routed to a queue consumer immediately. If
this flag is set, the server will return an
undeliverable message with a Return method. If this
flag is zero, the server will queue the message, but
with no guarantee that it will ever be consumed.
RULE:
The server SHOULD implement the immediate flag.
timeout: short
timeout for publish
Set timeout to wait maximum timeout second
for message to publish.
confirm_timeout: short
confirm_timeout for publish in confirm mode
When the channel is in confirm mode set
confirm_timeout to wait maximum confirm_timeout
second for message to confirm.
z basic_publish: connection closed� capabilitieszconnection.blockedFr )�timeoutNzbasic_publish: timed out)r0 r Zclient_properties�getZ drain_events�socketr� � transportZhaving_timeoutra r rD ZPublishr )
r3 r� ro r� � mandatoryZ immediater� �confirm_timeoutrd r� r r r �_basic_publish� s( [�� �(zChannel._basic_publishc O sh |� dd �}dd� }| js(d| _| �� | j|i |��}|pF|�dd �}| jtjjtjj g||d� |S )Nr� c W s | t jjkrt� �d S r8 )r rD rO r
)�method�argsr r r �confirm_handler s z6Channel.basic_publish_confirm.<locals>.confirm_handlerTr� )r� r� )
rT r) �confirm_selectr� r� r_ r rD rM rO )r3 r� �kwargsr� r� r� r� r r r r1 s �z Channel.basic_publish_confirm�lBbc C s | j tjj||||ftjjd�S )a� 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.
PARAMETERS:
prefetch_size: long
prefetch window in octets
The client can request that messages be sent in
advance so that when the client finishes processing a
message, the following message is already held
locally, rather than needing to be sent down the
channel. Prefetching gives a performance improvement.
This field specifies the prefetch window size in
octets. The server will send a message in advance if
it is equal to or smaller in size than the available
prefetch size (and also falls into other prefetch
limits). May be set to zero, meaning "no specific
limit", although other prefetch limits may still
apply. The prefetch-size is ignored if the no-ack
option is set.
RULE:
The server MUST ignore this setting when the
client is not processing any messages - i.e. the
prefetch size does not limit the transfer of
single messages to a client, only the sending in
advance of more messages while the client still
has one or more unacknowledged messages.
prefetch_count: short
prefetch window in messages
Specifies a prefetch window in terms of whole
messages. This field may be used in combination with
the prefetch-size field; a message will only be sent
in advance if both prefetch windows (and those at the
channel and connection level) allow it. The prefetch-
count is ignored if the no-ack option is set.
RULE:
The server MAY send less data in advance than
allowed by the client's specified prefetch windows
but it MUST NOT send more.
a_global: boolean
Defines a scope of QoS. Semantics of this parameter differs
between AMQP 0-9-1 standard and RabbitMQ broker:
MEANING IN AMQP 0-9-1:
False: shared across all consumers on the channel
True: shared across all consumers on the connection
MEANING IN RABBITMQ:
False: applied separately to each new consumer
on the channel
True: shared across all consumers on the channel
r^ )ra r rD ZQos�QosOk)r3 Z
prefetch_sizeZprefetch_countZa_globalrd r r r � basic_qos! s E�zChannel.basic_qosc C s | � tjjd|f�S )a{ Redeliver unacknowledged messages.
This method asks the broker to redeliver all unacknowledged
messages on a specified channel. Zero or more messages may be
redelivered. This method is only allowed on non-transacted
channels.
RULE:
The server MUST set the redelivered flag on all messages
that are resent.
RULE:
The server MUST raise a channel exception if this is
called on a transacted channel.
PARAMETERS:
requeue: boolean
requeue the message
If this field is False, the message will be redelivered
to the original recipient. If this field is True, the
server will attempt to requeue the message,
potentially then delivering it to an alternative
subscriber.
r )ra r rD ZRecover�r3 r� r r r �
basic_recoverk s zChannel.basic_recoverc C s | � tjjd|f�S )Nr )ra r rD Z RecoverAsyncr� r r r �basic_recover_async� s zChannel.basic_recover_asyncc C s | � tjj|||f�S )a&
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.
RULE:
The server SHOULD be capable of accepting and process the
Reject method while sending message content with a Deliver
or Get-Ok method. I.e. the server should read and process
incoming methods while sending output frames. To cancel a
partially-send content, the server sends a content body
frame of size 1 (i.e. with no data except the frame-end
octet).
RULE:
The server SHOULD interpret this method as meaning that
the client is unable to process the message at this time.
RULE:
A client MUST NOT use this method as a means of selecting
messages to process. A rejected message MAY be discarded
or dead-lettered, not necessarily passed to another
client.
PARAMETERS:
delivery_tag: longlong
server-assigned delivery tag
The server-assigned and channel-specific delivery tag
RULE:
The delivery tag is valid only within the channel
from which the message was received. I.e. a client
MUST NOT receive a message on one channel and then
acknowledge it on another.
RULE:
The server MUST NOT use a zero value for delivery
tags. Zero is reserved for client use, meaning "all
messages so far received".
requeue: boolean
requeue the message
If this field is False, the message will be discarded.
If this field is True, the server will attempt to
requeue the message.
RULE:
The server MUST NOT deliver the message to the
same client within the context of the current
channel. The recommended strategy is to attempt
to deliver the message to an alternative consumer,
and if that is not possible, to move the message
to a dead-letter queue. The server MAY use more
sophisticated tracking to hold the message on the
queue and redeliver it to the same client at a
later stage.
)ra r rD ZReject)r3 r� r� rd r r r r� � s E�zChannel.basic_rejectc C sB t ||tjjt�}| j�d�}|s&|�|D ]}|||||� q*dS )a� 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: short
The reply code. The AMQ reply codes are defined in AMQ
RFC 011.
reply_text: shortstr
The localised reply text. This text can be logged as an
aid to resolving issues.
exchange: shortstr
Specifies the name of the exchange that the message
was originally published to.
routing_key: shortstr
Message routing key
Specifies the routing key name specified when the
message was published.
Z basic_returnN)r
r rD rK r r& r� ) r3 rb rc ro r� �message�exc�handlersr� r r r rL � s ! � zChannel._on_basic_returnc C s | j tjjtjjd�S )z�Commit the current transaction.
This method commits all messages published and acknowledged in
the current transaction. A new transaction starts immediately
after a commit.
r^ )ra r �TxZCommit�CommitOkrQ r r r � tx_commit s zChannel.tx_commitc C s | j tjjtjjd�S )z�Abandon the current transaction.
This method abandons all messages published and acknowledged
in the current transaction. A new transaction starts
immediately after a rollback.
r^ )ra r r� ZRollback�
RollbackOkrQ r r r � tx_rollback% s zChannel.tx_rollbackc C s | j tjjtjjd�S )z�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.
r^ )ra r r� �Select�SelectOkrQ r r r � tx_select. s zChannel.tx_selectc C s$ | j tjjd|f|rdntjjd�S )a� Enable publisher confirms for this channel.
Note: This is an RabbitMQ extension.
Can now be used if the channel is in transactional mode.
:param nowait:
If set, the server will not respond to the method.
The client should not wait for a reply method. If the
server could not complete the method it will raise a channel
or connection exception.
r Nr^ )ra r �Confirmr� r� )r3 rt r r r r� 7 s
�zChannel.confirm_selectc C s | j d D ]}|||� q
d S )Nr� �r& �r3 r� r� r� r r r rN I s zChannel._on_basic_ackc C s | j d D ]}|||� q
d S )NZ
basic_nackr� r� r r r rP M s zChannel._on_basic_nack)NTN)N)r r[ r\ r )FFTFNrk )FFrw )r[ r[ FNr| )r[ r[ FNr| )r[ r[ FNr| )r[ FNr� )r[ FFFTFNr� )r[ FFFr� )r[ Fr� )Fr )Fr� )
r[ r[ FFFFNNNr� )r[ Fr� )N)r[ r[ FFNNr� )r� )F)F)r )F)Ur r r �__doc__r r� r r< r> r@ rg rB rl rn ry r~ r� r r� rD rE rG r� rI r� r� r� Z RecoverOkrK r� r� r� r� r� rM rO Z_METHODSZ _ALLOWED_METHODS_WHEN_CLOSINGr- r9 rR rX rZ re r= r? ri rA rj rY rC rv r{ r� r� r� r� r� r� r� r� r� rF rH r� r� rJ r� r� r� r� r2 r1 r� r� r� r� rL r� r� r� r� rN rP �
__classcell__r r r6 r r s� � � �(
�
A5101 �
�
0 �
N �
S �
i �
9 �
% �
K
x
2
. �
-
�
q �
J
IF
r ) r� �loggingr� � collectionsr r� r Zviner r[ r Zabstract_channelr �
exceptionsr r r
r r r
�protocolr �__all__� getLoggerr* r� �DeprecationWarningr r r r r r �<module> s