│ │ │ │ │ │
│ │ │

Introduction to Pika

│ │ │
│ │ │

IO and Event Looping

│ │ │

As AMQP is a two-way RPC protocol where the client can send requests to the server and the server can send requests to a client, Pika implements or extends IO loops in each of its asynchronous connection adapters. These IO loops are blocking methods which loop and listen for events. Each asynchronous adapter follows the same standard for invoking the IO loop. The IO loop is created when the connection adapter is created. To start an IO loop for any given adapter, call the connection.ioloop.start() method.

│ │ │ -

If you are using an external IO loop such as Tornado’s IOLoop you invoke it normally and then add the Pika Tornado adapter to it.

│ │ │ +

If you are using an external IO loop such as Tornado’s IOLoop you invoke it normally and then add the Pika Tornado adapter to it.

│ │ │

Example:

│ │ │
import pika
│ │ │  
│ │ │  def on_open(connection):
│ │ │      # Invoked when the connection is open
│ │ │      pass
│ │ ├── ./usr/share/doc/python-pika-doc/html/modules/adapters/asyncio.html
│ │ │ @@ -49,15 +49,15 @@
│ │ │  
│ │ │  
│ │ │  
│ │ │  Parameters:
    │ │ │
  • parameters (pika.connection.Parameters) – Connection parameters
  • │ │ │
  • on_open_callback (method) – The method to call when the connection is open
  • │ │ │
  • on_open_error_callback (method) – Method to call if the connection cant be opened
  • │ │ │ -
  • loop (asyncio.AbstractEventLoop) – By default asyncio.get_event_loop()
  • │ │ │ +
  • loop (asyncio.AbstractEventLoop) – By default asyncio.get_event_loop()
  • │ │ │
│ │ │ │ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │ @@ -154,15 +154,15 @@ │ │ │ connect, and an optional error message.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
Parameters:
    │ │ │
  • callback_method (method) – Callback to call when can’t connect
  • │ │ │ -
  • remove_default (bool) – Remove default exception raising callback
  • │ │ │ +
  • remove_default (bool) – Remove default exception raising callback
  • │ │ │
│ │ │
│ │ │
│ │ │ │ │ │ @@ -172,35 +172,35 @@ │ │ │

Add the callback_method to the IOLoop timer to fire after deadline │ │ │ seconds. Returns a handle to the timeout

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
Parameters:
    │ │ │ -
  • deadline (int) – The number of seconds to wait to call callback
  • │ │ │ +
  • deadline (int) – The number of seconds to wait to call callback
  • │ │ │
  • callback_method (method) – The callback method
  • │ │ │
│ │ │
Return type:

str

│ │ │ +
Return type:

str

│ │ │
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ basic_nack
│ │ │

Specifies if the server supports basic.nack on the active connection.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -211,15 +211,15 @@ │ │ │ numbers.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -235,16 +235,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

│ │ │
Parameters:
    │ │ │
  • on_open_callback (method) – The callback when the channel is opened
  • │ │ │ -
  • channel_number (int) – The channel number to use, defaults to the │ │ │ +
  • channel_number (int) – The channel number to use, defaults to the │ │ │ next available.
  • │ │ │
│ │ │
Return type:

pika.channel.Channel

│ │ │
│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
Parameters:
    │ │ │ -
  • reply_code (int) – The code number for the close
  • │ │ │ -
  • reply_text (str) – The text reason for the close
  • │ │ │ +
  • reply_code (int) – The code number for the close
  • │ │ │ +
  • reply_text (str) – The text reason for the close
  • │ │ │
│ │ │
│ │ │
│ │ │ │ │ │ @@ -260,30 +260,30 @@ │ │ │ consumer_cancel_notify │ │ │

Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ exchange_exchange_bindings
│ │ │

Specifies if the active connection supports exchange to exchange │ │ │ bindings.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -308,30 +308,30 @@ │ │ │
│ │ │ publisher_confirms
│ │ │

Specifies if the active connection can use publisher confirmations.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ remove_timeout(timeout_id)
│ │ │

Remove the timeout from the IOLoop by the ID returned from │ │ │ add_timeout.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:str
Return type:str
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -339,15 +339,15 @@ │ │ │

Alter the backpressure multiplier value. We set this to 10 by default. │ │ │ This value is used to raise warnings and trigger the backpressure │ │ │ callback.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Parameters:value (int) – The multiplier value to set
Parameters:value (int) – The multiplier value to set
│ │ │
│ │ │ │ │ │ │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/adapters/blocking.html │ │ │ @@ -162,15 +162,15 @@ │ │ │ BlockingConnection.process_data_events and │ │ │ BlockingChannel.start_consuming.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -183,29 +183,29 @@ │ │ │
│ │ │ basic_nack
│ │ │

Specifies if the server supports basic.nack on the active connection.

│ │ │
Parameters:
    │ │ │ -
  • deadline (float) – The number of seconds to wait to call callback
  • │ │ │ +
  • deadline (float) – The number of seconds to wait to call callback
  • │ │ │
  • callback_method (callable) – The callback method with the signature │ │ │ callback_method()
  • │ │ │
│ │ │
Returns:

opaque timer id

│ │ │
│ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │ │ │ │ │ │ │
│ │ │
│ │ │ basic_nack_supported
│ │ │

Specifies if the server supports basic.nack on the active connection.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -232,16 +232,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
Parameters:
    │ │ │ -
  • reply_code (int) – The code number for the close
  • │ │ │ -
  • reply_text (str) – The text reason for the close
  • │ │ │ +
  • reply_code (int) – The code number for the close
  • │ │ │ +
  • reply_text (str) – The text reason for the close
  • │ │ │
│ │ │
│ │ │
│ │ │ │ │ │ @@ -250,60 +250,60 @@ │ │ │ consumer_cancel_notify │ │ │

Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ consumer_cancel_notify_supported
│ │ │

Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ exchange_exchange_bindings
│ │ │

Specifies if the active connection supports exchange to exchange │ │ │ bindings.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ exchange_exchange_bindings_supported
│ │ │

Specifies if the active connection supports exchange to exchange │ │ │ bindings.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -330,15 +330,15 @@ │ │ │

Will make sure that data events are processed. Dispatches timer and │ │ │ channel callbacks if not called from the scope of BlockingConnection or │ │ │ BlockingChannel callback. Your app can block on this method.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │ @@ -349,29 +349,29 @@ │ │ │
│ │ │ publisher_confirms
│ │ │

Specifies if the active connection can use publisher confirmations.

│ │ │
Parameters:time_limit (float) – suggested upper bound on processing time in │ │ │ +
Parameters:time_limit (float) – suggested upper bound on processing time in │ │ │ seconds. The actual blocking time depends on the granularity of the │ │ │ underlying ioloop. Zero means return as soon as possible. None means │ │ │ there is no limit on processing time and the function will block │ │ │ until I/O produces actionable events. Defaults to 0 for backward │ │ │ compatibility. This parameter is NEW in pika 0.10.0.
│ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ publisher_confirms_supported
│ │ │

Specifies if the active connection can use publisher confirmations.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Return type:bool
Return type:bool
│ │ │
│ │ │ │ │ │
│ │ │
│ │ │ @@ -394,29 +394,29 @@ │ │ │ keep the adapter from ignoring frames sent from the broker. The │ │ │ connection will “sleep” or block the number of seconds specified in │ │ │ duration in small intervals.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
Parameters:duration (float) – The time to sleep in seconds
Parameters:duration (float) – The time to sleep in seconds
│ │ │
│ │ │ │ │ │ │ │ │ │ │ │
│ │ │
│ │ │ class pika.adapters.blocking_connection.BlockingChannel(channel_impl, connection)
│ │ │

The BlockingChannel implements blocking semantics for most things that │ │ │ one would use callback-passing-style for with the │ │ │ Channel class. In addition, │ │ │ -the BlockingChannel class implements a generator that allows │ │ │ +the BlockingChannel class implements a generator that allows │ │ │ you to consume messages │ │ │ without using callbacks.

│ │ │

Example of creating a BlockingChannel:

│ │ │
import pika
│ │ │  
│ │ │  # Create our connection object
│ │ │  connection = pika.BlockingConnection()
│ │ │ @@ -474,16 +474,16 @@
│ │ │  confirm mode. The acknowledgement can be for a single message or a
│ │ │  set of messages up to and including a specific message.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │
Parameters:
    │ │ │ -
  • delivery-tag (int) – The server-assigned delivery tag
  • │ │ │ -
  • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ +
  • delivery-tag (int) – The server-assigned delivery tag
  • │ │ │ +
  • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ “up to and including”, so that multiple messages │ │ │ can be acknowledged with a single method. If set │ │ │ to False, the delivery tag refers to a single │ │ │ message. If the multiple field is 1, and the │ │ │ delivery tag is zero, this indicates │ │ │ acknowledgement of all outstanding messages.
  • │ │ │
│ │ │ @@ -506,15 +506,15 @@ │ │ │ yet been dispatched to the consumer’s callback. However, when cancelling │ │ │ a no_ack=True consumer, this method will return any pending messages │ │ │ that arrived before broker confirmed the cancellation.

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -587,26 +587,26 @@ │ │ │

Get a single message from the AMQP broker. Returns a sequence with │ │ │ the method frame, message properties, and body.

│ │ │
Parameters:consumer_tag (str) – Identifier for the consumer; the result of │ │ │ +
Parameters:consumer_tag (str) – Identifier for the consumer; the result of │ │ │ passing a consumer_tag that was created on another channel is │ │ │ undefined (bad things will happen)
Returns:(NEW IN pika 0.10.0) empty sequence for a no_ack=False │ │ │ consumer; for a no_ack=True consumer, returns a (possibly empty) │ │ │ sequence of pending messages that arrived before broker confirmed │ │ │ the cancellation (this is done instead of via consumer’s callback in │ │ │ @@ -553,28 +553,28 @@ │ │ │ consumer_callback(channel, method, properties, body)

│ │ │
│ │ │
channel: BlockingChannel │ │ │ method: spec.Basic.Deliver │ │ │ properties: spec.BasicProperties │ │ │ body: str or unicode
│ │ │ │ │ │ -
  • queue (str or unicode) – The queue to consume from
  • │ │ │ -
  • no_ack (bool) – Tell the broker to not expect a response (i.e., │ │ │ +
  • queue (str or unicode) – The queue to consume from
  • │ │ │ +
  • no_ack (bool) – Tell the broker to not expect a response (i.e., │ │ │ no ack/nack)
  • │ │ │ -
  • exclusive (bool) – Don’t allow other consumers on the queue
  • │ │ │ -
  • consumer_tag (str or unicode) – You may specify your own consumer tag; if left │ │ │ +
  • exclusive (bool) – Don’t allow other consumers on the queue
  • │ │ │ +
  • consumer_tag (str or unicode) – You may specify your own consumer tag; if left │ │ │ empty, a consumer tag will be generated automatically
  • │ │ │ -
  • arguments (dict) – Custom key/value pair arguments for the consumer
  • │ │ │ +
  • arguments (dict) – Custom key/value pair arguments for the consumer
  • │ │ │ │ │ │
    Returns:

    consumer tag

    │ │ │
    Return type:

    str

    │ │ │ +
    Return type:

    str

    │ │ │
    Raises:

    pika.exceptions.DuplicateConsumerTag – if consumer with given │ │ │ consumer_tag is already present.

    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • queue (str or unicode) – Name of queue to get a message from
    • │ │ │ -
    • no_ack (bool) – Tell the broker to not expect a reply
    • │ │ │ +
    • queue (str or unicode) – Name of queue to get a message from
    • │ │ │ +
    • no_ack (bool) – Tell the broker to not expect a reply
    • │ │ │
    │ │ │
    Returns:

    a three-tuple; (None, None, None) if the queue was empty; │ │ │ otherwise (method, properties, body); NOTE: body may be None

    │ │ │
    Return type:

    (None, None, None)|(spec.Basic.GetOk, │ │ │ +

    Return type:

    (None, None, None)|(spec.Basic.GetOk, │ │ │ spec.BasicProperties, │ │ │ -str or unicode or None)

    │ │ │ +str or unicode or None)

    │ │ │
    │ │ │ │ │ │ │ │ │
    │ │ │ @@ -616,23 +616,23 @@ │ │ │ It can be used to interrupt and cancel large incoming messages, or │ │ │ return untreatable messages to their original queue.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -656,20 +656,20 @@ │ │ │ the Basic.Return or lack thereof. │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • delivery-tag (int) – The server-assigned delivery tag
    • │ │ │ -
    • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ +
    • delivery-tag (int) – The server-assigned delivery tag
    • │ │ │ +
    • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ “up to and including”, so that multiple messages │ │ │ can be acknowledged with a single method. If set │ │ │ to False, the delivery tag refers to a single │ │ │ message. If the multiple field is 1, and the │ │ │ delivery tag is zero, this indicates │ │ │ acknowledgement of all outstanding messages.
    • │ │ │ -
    • requeue (bool) – If requeue is true, the server will attempt to │ │ │ +
    • requeue (bool) – If requeue is true, the server will attempt to │ │ │ requeue the message. If requeue is false or the │ │ │ requeue attempt fails the messages are discarded or │ │ │ dead-lettered.
    • │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • exchange (str or unicode) – The exchange to publish to
    • │ │ │ -
    • routing_key (str or unicode) – The routing key to bind on
    • │ │ │ -
    • body (str or unicode) – The message body; empty string if no body
    • │ │ │ +
    • exchange (str or unicode) – The exchange to publish to
    • │ │ │ +
    • routing_key (str or unicode) – The routing key to bind on
    • │ │ │ +
    • body (str or unicode) – The message body; empty string if no body
    • │ │ │
    • properties (pika.spec.BasicProperties) – message properties
    • │ │ │ -
    • mandatory (bool) – The mandatory flag
    • │ │ │ -
    • immediate (bool) – The immediate flag
    • │ │ │ +
    • mandatory (bool) – The mandatory flag
    • │ │ │ +
    • immediate (bool) – The immediate flag
    • │ │ │
    │ │ │
    Returns:

    True if delivery confirmation is not enabled (NEW in pika │ │ │ 0.10.0); otherwise returns False if the message could not be │ │ │ delivered (Basic.nack and/or Basic.Return) and True if the message │ │ │ was delivered (Basic.ack and no Basic.Return)

    │ │ │ @@ -689,32 +689,32 @@ │ │ │ following message is already held locally, rather than needing to be │ │ │ sent down the channel. Prefetching gives a performance improvement.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • prefetch_size (int) – This field specifies the prefetch window │ │ │ +
    • prefetch_size (int) – This field specifies the prefetch window │ │ │ size. 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 in the consumer.
    • │ │ │ -
    • prefetch_count (int) – Specifies a prefetch window in terms of whole │ │ │ +
    • prefetch_count (int) – 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 in the consumer.
    • │ │ │ -
    • all_channels (bool) – Should the QoS apply to all channels
    • │ │ │ +
    • all_channels (bool) – Should the QoS apply to all channels
    • │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ @@ -724,15 +724,15 @@ │ │ │

    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) – If False, the message will be redelivered to the │ │ │ +
    Parameters:requeue (bool) – If False, the message will be redelivered to the │ │ │ original recipient. If True, the server will │ │ │ attempt to requeue the message, potentially then │ │ │ delivering it to an alternative subscriber.
    │ │ │
    │ │ │ @@ -744,16 +744,16 @@ │ │ │ message. It can be used to interrupt and cancel large incoming messages, │ │ │ or return untreatable messages to their original queue.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -790,16 +790,16 @@ │ │ │ close(reply_code=0, reply_text='Normal shutdown') │ │ │

    Will invoke a clean shutdown of the channel with the AMQP Broker.

    │ │ │
    Parameters:
      │ │ │ -
    • delivery-tag (int) – The server-assigned delivery tag
    • │ │ │ -
    • requeue (bool) – If requeue is true, the server will attempt to │ │ │ +
    • delivery-tag (int) – The server-assigned delivery tag
    • │ │ │ +
    • requeue (bool) – If requeue is true, the server will attempt to │ │ │ requeue the message. If requeue is false or the │ │ │ requeue attempt fails the messages are discarded or │ │ │ dead-lettered.
    • │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • reply_code (int) – The reply code to close the channel with
    • │ │ │ -
    • reply_text (str) – The reply text to close the channel with
    • │ │ │ +
    • reply_code (int) – The reply code to close the channel with
    • │ │ │ +
    • reply_text (str) – The reply text to close the channel with
    • │ │ │
    │ │ │
    │ │ │ │ │ │ │ │ │ @@ -841,33 +841,33 @@ │ │ │ will resume the existing consumer generator; however, calling with │ │ │ different parameters will result in an exception.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • queue (str or unicode) – The queue name to consume
    • │ │ │ -
    • no_ack (bool) – Tell the broker to not expect a ack/nack response
    • │ │ │ -
    • exclusive (bool) – Don’t allow other consumers on the queue
    • │ │ │ -
    • arguments (dict) – Custom key/value pair arguments for the consumer
    • │ │ │ -
    • inactivity_timeout (float) – if a number is given (in │ │ │ +
    • queue (str or unicode) – The queue name to consume
    • │ │ │ +
    • no_ack (bool) – Tell the broker to not expect a ack/nack response
    • │ │ │ +
    • exclusive (bool) – Don’t allow other consumers on the queue
    • │ │ │ +
    • arguments (dict) – Custom key/value pair arguments for the consumer
    • │ │ │ +
    • inactivity_timeout (float) – if a number is given (in │ │ │ seconds), will cause the method to yield None after the given period │ │ │ of inactivity; this permits for pseudo-regular maintenance │ │ │ activities to be carried out by the user while waiting for messages │ │ │ to arrive. If None is given (default), then the method blocks until │ │ │ the next event arrives. NOTE that timing granularity is limited by │ │ │ the timer resolution of the underlying implementation. │ │ │ NEW in pika 0.10.0.
    • │ │ │
    │ │ │
    Yields:

    tuple(spec.Basic.Deliver, spec.BasicProperties, str or unicode)

    │ │ │
    Raises:

    ValueError – if consumer-creation parameters don’t match those │ │ │ +

    Raises:

    ValueError – if consumer-creation parameters don’t match those │ │ │ of the existing queue consumer generator, if any. │ │ │ NEW in pika 0.10.0

    │ │ │
    │ │ │ │ │ │ @@ -877,18 +877,18 @@ │ │ │ exchange_bind(destination=None, source=None, routing_key='', arguments=None) │ │ │

    Bind an exchange to another exchange.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • destination (str or unicode) – The destination exchange to bind
    • │ │ │ -
    • source (str or unicode) – The source exchange to bind to
    • │ │ │ -
    • routing_key (str or unicode) – The routing key to bind on
    • │ │ │ -
    • arguments (dict) – Custom key/value pair arguments for the binding
    • │ │ │ +
    • destination (str or unicode) – The destination exchange to bind
    • │ │ │ +
    • source (str or unicode) – The source exchange to bind to
    • │ │ │ +
    • routing_key (str or unicode) – The routing key to bind on
    • │ │ │ +
    • arguments (dict) – Custom key/value pair arguments for the binding
    • │ │ │
    │ │ │
    Returns:

    Method frame from the Exchange.Bind-ok response

    │ │ │
    Return type:

    pika.frame.Method having method attribute of type │ │ │ @@ -910,23 +910,23 @@ │ │ │ exchange does not already exist, the server MUST raise a channel │ │ │ exception with reply code 404 (not found).

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • exchange (str or unicode) – The exchange name consists of a non-empty sequence of │ │ │ +
    • exchange (str or unicode) – The exchange name consists of a non-empty sequence of │ │ │ these characters: letters, digits, hyphen, underscore, │ │ │ period, or colon.
    • │ │ │ -
    • exchange_type (str) – The exchange type to use
    • │ │ │ -
    • passive (bool) – Perform a declare or just check to see if it exists
    • │ │ │ -
    • durable (bool) – Survive a reboot of RabbitMQ
    • │ │ │ -
    • auto_delete (bool) – Remove when no more queues are bound to it
    • │ │ │ -
    • internal (bool) – Can only be published to by other exchanges
    • │ │ │ -
    • arguments (dict) – Custom key/value pair arguments for the exchange
    • │ │ │ +
    • exchange_type (str) – The exchange type to use
    • │ │ │ +
    • passive (bool) – Perform a declare or just check to see if it exists
    • │ │ │ +
    • durable (bool) – Survive a reboot of RabbitMQ
    • │ │ │ +
    • auto_delete (bool) – Remove when no more queues are bound to it
    • │ │ │ +
    • internal (bool) – Can only be published to by other exchanges
    • │ │ │ +
    • arguments (dict) – Custom key/value pair arguments for the exchange
    • │ │ │
    │ │ │
    Returns:

    Method frame from the Exchange.Declare-ok response

    │ │ │
    Return type:

    pika.frame.Method having method attribute of type │ │ │ @@ -942,16 +942,16 @@ │ │ │ exchange_delete(exchange=None, if_unused=False) │ │ │

    Delete the exchange.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • exchange (str or unicode) – The exchange name
    • │ │ │ -
    • if_unused (bool) – only delete if the exchange is unused
    • │ │ │ +
    • exchange (str or unicode) – The exchange name
    • │ │ │ +
    • if_unused (bool) – only delete if the exchange is unused
    • │ │ │
    │ │ │
    Returns:

    Method frame from the Exchange.Delete-ok response

    │ │ │
    Return type:

    pika.frame.Method having method attribute of type │ │ │ @@ -967,18 +967,18 @@ │ │ │ exchange_unbind(destination=None, source=None, routing_key='', arguments=None) │ │ │

    Unbind an exchange from another exchange.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • destination (str or unicode) – The destination exchange to unbind
    • │ │ │ -
    • source (str or unicode) – The source exchange to unbind from
    • │ │ │ -
    • routing_key (str or unicode) – The routing key to unbind
    • │ │ │ -
    • arguments (dict) – Custom key/value pair arguments for the binding
    • │ │ │ +
    • destination (str or unicode) – The destination exchange to unbind
    • │ │ │ +
    • source (str or unicode) – The source exchange to unbind from
    • │ │ │ +
    • routing_key (str or unicode) – The routing key to unbind
    • │ │ │ +
    • arguments (dict) – Custom key/value pair arguments for the binding
    • │ │ │
    │ │ │
    Returns:

    Method frame from the Exchange.Unbind-ok response

    │ │ │
    Return type:

    pika.frame.Method having method attribute of type │ │ │ @@ -999,19 +999,19 @@ │ │ │ better control”

    │ │ │

    For more information, please reference:

    │ │ │

    http://www.rabbitmq.com/amqp-0-9-1-reference.html#channel.flow

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
    Parameters:active (bool) – Turn flow on (True) or off (False)
    Parameters:active (bool) – Turn flow on (True) or off (False)
    Returns:True if broker will start or continue sending; False if not
    Return type:bool
    Return type:bool
    │ │ │ │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -1019,58 +1019,58 @@ │ │ │

    Returns the number of messages that may be retrieved from the current │ │ │ queue consumer generator via BlockingChannel.consume without blocking. │ │ │ NEW in pika 0.10.0

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
    Return type:int
    Return type:int
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ is_closed
    │ │ │

    Returns True if the channel is closed.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
    Return type:bool
    Return type:bool
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ is_closing
    │ │ │

    Returns True if client-initiated closing of the channel is in │ │ │ progress.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
    Return type:bool
    Return type:bool
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ is_open
    │ │ │

    Returns True if the channel is open.

    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
    Return type:bool
    Return type:bool
    │ │ │
    │ │ │ │ │ │
    │ │ │
    │ │ │ @@ -1088,20 +1088,20 @@ │ │ │ the Basic.Return. │ │ │
    │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
    Parameters:
      │ │ │ -
    • exchange (str or unicode) – The exchange to publish to
    • │ │ │ -
    • routing_key (str or unicode) – The routing key to bind on
    • │ │ │ -
    • body (str or unicode) – The message body; empty string if no body
    • │ │ │ +
    • exchange (str or unicode) – The exchange to publish to
    • │ │ │ +
    • routing_key (str or unicode) – The routing key to bind on
    • │ │ │ +
    • body (str or unicode) – The message body; empty string if no body
    • │ │ │
    • properties (pika.spec.BasicProperties) – message properties
    • │ │ │ -
    • mandatory (bool) – The mandatory flag
    • │ │ │ -
    • immediate (bool) – The immediate flag
    • │ │ │ +
    • mandatory (bool) – The mandatory flag
    • │ │ │ +
    • immediate (bool) – The immediate flag
    • │ │ │
    │ │ │
    Raises:
      │ │ │
    • UnroutableError – raised when a message published in │ │ │ publisher-acknowledgments mode (see │ │ │ BlockingChannel.confirm_delivery) is returned via Basic.Return │ │ │ @@ -1121,18 +1121,18 @@ │ │ │ queue_bind(queue, exchange, routing_key=None, arguments=None) │ │ │

      Bind the queue to the specified exchange

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • queue (str or unicode) – The queue to bind to the exchange
      • │ │ │ -
      • exchange (str or unicode) – The source exchange to bind to
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │ +
      • queue (str or unicode) – The queue to bind to the exchange
      • │ │ │ +
      • exchange (str or unicode) – The source exchange to bind to
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │
      │ │ │
      Returns:

      Method frame from the Queue.Bind-ok response

      │ │ │
      Return type:

      pika.frame.Method having method attribute of type │ │ │ @@ -1152,21 +1152,21 @@ │ │ │ and the level of sharing for the queue.

      │ │ │

      Leave the queue name empty for a auto-named queue in RabbitMQ

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • queue (str or unicode; if empty string, the broker will create a │ │ │ +
      • queue (str or unicode; if empty string, the broker will create a │ │ │ unique queue name;) – The queue name
      • │ │ │ -
      • passive (bool) – Only check to see if the queue exists
      • │ │ │ -
      • durable (bool) – Survive reboots of the broker
      • │ │ │ -
      • exclusive (bool) – Only allow access by the current connection
      • │ │ │ -
      • auto_delete (bool) – Delete after consumer cancels or disconnects
      • │ │ │ -
      • arguments (dict) – Custom key/value arguments for the queue
      • │ │ │ +
      • passive (bool) – Only check to see if the queue exists
      • │ │ │ +
      • durable (bool) – Survive reboots of the broker
      • │ │ │ +
      • exclusive (bool) – Only allow access by the current connection
      • │ │ │ +
      • auto_delete (bool) – Delete after consumer cancels or disconnects
      • │ │ │ +
      • arguments (dict) – Custom key/value arguments for the queue
      • │ │ │
      │ │ │
      Returns:

      Method frame from the Queue.Declare-ok response

      │ │ │
      Return type:

      pika.frame.Method having method attribute of type │ │ │ @@ -1182,17 +1182,17 @@ │ │ │ queue_delete(queue='', if_unused=False, if_empty=False) │ │ │

      Delete a queue from the broker.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • queue (str or unicode) – The queue to delete
      • │ │ │ -
      • if_unused (bool) – only delete if it’s unused
      • │ │ │ -
      • if_empty (bool) – only delete if the queue is empty
      • │ │ │ +
      • queue (str or unicode) – The queue to delete
      • │ │ │ +
      • if_unused (bool) – only delete if it’s unused
      • │ │ │ +
      • if_empty (bool) – only delete if the queue is empty
      • │ │ │
      │ │ │
      Returns:

      Method frame from the Queue.Delete-ok response

      │ │ │
      Return type:

      pika.frame.Method having method attribute of type │ │ │ @@ -1207,15 +1207,15 @@ │ │ │

      │ │ │ queue_purge(queue='')
      │ │ │

      Purge all of the messages from the specified queue

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -1227,18 +1227,18 @@ │ │ │ queue_unbind(queue='', exchange=None, routing_key=None, arguments=None) │ │ │

      Unbind a queue from an exchange.

      │ │ │
      Parameters:queue (str or unicode) – The queue to purge
      Parameters:queue (str or unicode) – The queue to purge
      Returns:Method frame from the Queue.Purge-ok response
      Return type:pika.frame.Method having method attribute of type │ │ │ spec.Queue.PurgeOk
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • queue (str or unicode) – The queue to unbind from the exchange
      • │ │ │ -
      • exchange (str or unicode) – The source exchange to bind from
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to unbind
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │ +
      • queue (str or unicode) – The queue to unbind from the exchange
      • │ │ │ +
      • exchange (str or unicode) – The source exchange to bind from
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to unbind
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │
      │ │ │
      Returns:

      Method frame from the Queue.Unbind-ok response

      │ │ │
      Return type:

      pika.frame.Method having method attribute of type │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/adapters/select.html │ │ │ @@ -151,15 +151,15 @@ │ │ │ connect, and an optional error message.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback_method (method) – Callback to call when can’t connect
      • │ │ │ -
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │ +
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -169,35 +169,35 @@ │ │ │

      Add the callback_method to the IOLoop timer to fire after deadline │ │ │ seconds. Returns a handle to the timeout

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │ +
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │
      • callback_method (method) – The callback method
      • │ │ │
      │ │ │
      Return type:

      str

      │ │ │ +
      Return type:

      str

      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ basic_nack
      │ │ │

      Specifies if the server supports basic.nack on the active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -208,15 +208,15 @@ │ │ │ numbers.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -232,16 +232,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

      │ │ │
      Parameters:
        │ │ │
      • on_open_callback (method) – The callback when the channel is opened
      • │ │ │ -
      • channel_number (int) – The channel number to use, defaults to the │ │ │ +
      • channel_number (int) – The channel number to use, defaults to the │ │ │ next available.
      • │ │ │
      │ │ │
      Return type:

      pika.channel.Channel

      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • reply_code (int) – The code number for the close
      • │ │ │ -
      • reply_text (str) – The text reason for the close
      • │ │ │ +
      • reply_code (int) – The code number for the close
      • │ │ │ +
      • reply_text (str) – The text reason for the close
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -257,30 +257,30 @@ │ │ │ consumer_cancel_notify │ │ │

      Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ exchange_exchange_bindings
      │ │ │

      Specifies if the active connection supports exchange to exchange │ │ │ bindings.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -305,30 +305,30 @@ │ │ │
      │ │ │ publisher_confirms
      │ │ │

      Specifies if the active connection can use publisher confirmations.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ remove_timeout(timeout_id)
      │ │ │

      Remove the timeout from the IOLoop by the ID returned from │ │ │ add_timeout.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -336,15 +336,15 @@ │ │ │

      Alter the backpressure multiplier value. We set this to 10 by default. │ │ │ This value is used to raise warnings and trigger the backpressure │ │ │ callback.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:value (int) – The multiplier value to set
      Parameters:value (int) – The multiplier value to set
      │ │ │
      │ │ │ │ │ │ │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/adapters/tornado.html │ │ │ @@ -63,15 +63,15 @@ │ │ │
      Parameters:
        │ │ │
      • parameters (pika.connection.Parameters) – Connection parameters
      • │ │ │
      • on_open_callback (method) – The method to call when the connection is open
      • │ │ │
      • on_open_error_callback (method) – Method to call if the connection cant │ │ │ be opened
      • │ │ │ -
      • stop_ioloop_on_close (bool) – Call ioloop.stop() if disconnected
      • │ │ │ +
      • stop_ioloop_on_close (bool) – Call ioloop.stop() if disconnected
      • │ │ │
      • custom_ioloop – Override using the global IOLoop in Tornado
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ @@ -169,15 +169,15 @@ │ │ │ connect, and an optional error message.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback_method (method) – Callback to call when can’t connect
      • │ │ │ -
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │ +
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -189,35 +189,35 @@ │ │ │ Tornado’s timeout where you pass in the time you want to have your │ │ │ callback called. Only pass in the seconds until it’s to be called.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │ +
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │
      • callback_method (method) – The callback method
      • │ │ │
      │ │ │
      Return type:

      str

      │ │ │ +
      Return type:

      str

      │ │ │
      │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │ basic_nack
      │ │ │

      Specifies if the server supports basic.nack on the active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -228,15 +228,15 @@ │ │ │ numbers.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -252,16 +252,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

      │ │ │
      Parameters:
        │ │ │
      • on_open_callback (method) – The callback when the channel is opened
      • │ │ │ -
      • channel_number (int) – The channel number to use, defaults to the │ │ │ +
      • channel_number (int) – The channel number to use, defaults to the │ │ │ next available.
      • │ │ │
      │ │ │
      Return type:

      pika.channel.Channel

      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • reply_code (int) – The code number for the close
      • │ │ │ -
      • reply_text (str) – The text reason for the close
      • │ │ │ +
      • reply_code (int) – The code number for the close
      • │ │ │ +
      • reply_text (str) – The text reason for the close
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -277,30 +277,30 @@ │ │ │ consumer_cancel_notify │ │ │

      Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ exchange_exchange_bindings
      │ │ │

      Specifies if the active connection supports exchange to exchange │ │ │ bindings.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -325,30 +325,30 @@ │ │ │
      │ │ │ publisher_confirms
      │ │ │

      Specifies if the active connection can use publisher confirmations.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ remove_timeout(timeout_id)
      │ │ │

      Remove the timeout from the IOLoop by the ID returned from │ │ │ add_timeout.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -356,15 +356,15 @@ │ │ │

      Alter the backpressure multiplier value. We set this to 10 by default. │ │ │ This value is used to raise warnings and trigger the backpressure │ │ │ callback.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:value (int) – The multiplier value to set
      Parameters:value (int) – The multiplier value to set
      │ │ │
      │ │ │ │ │ │ │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/adapters/twisted.html │ │ │ @@ -169,15 +169,15 @@ │ │ │ connect, and an optional error message.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback_method (method) – Callback to call when can’t connect
      • │ │ │ -
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │ +
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -187,35 +187,35 @@ │ │ │

      Add the callback_method to the IOLoop timer to fire after deadline │ │ │ seconds. Returns a handle to the timeout

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │ +
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │
      • callback_method (method) – The callback method
      • │ │ │
      │ │ │
      Return type:

      str

      │ │ │ +
      Return type:

      str

      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ basic_nack
      │ │ │

      Specifies if the server supports basic.nack on the active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -232,16 +232,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • reply_code (int) – The code number for the close
      • │ │ │ -
      • reply_text (str) – The text reason for the close
      • │ │ │ +
      • reply_code (int) – The code number for the close
      • │ │ │ +
      • reply_text (str) – The text reason for the close
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -257,30 +257,30 @@ │ │ │ consumer_cancel_notify │ │ │

      Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ exchange_exchange_bindings
      │ │ │

      Specifies if the active connection supports exchange to exchange │ │ │ bindings.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -305,30 +305,30 @@ │ │ │
      │ │ │ publisher_confirms
      │ │ │

      Specifies if the active connection can use publisher confirmations.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ remove_timeout(timeout_id)
      │ │ │

      Remove the timeout from the IOLoop by the ID returned from │ │ │ add_timeout.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -336,15 +336,15 @@ │ │ │

      Alter the backpressure multiplier value. We set this to 10 by default. │ │ │ This value is used to raise warnings and trigger the backpressure │ │ │ callback.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:value (int) – The multiplier value to set
      Parameters:value (int) – The multiplier value to set
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ @@ -457,15 +457,15 @@ │ │ │ connect, and an optional error message.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback_method (method) – Callback to call when can’t connect
      • │ │ │ -
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │ +
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -475,35 +475,35 @@ │ │ │

      Add the callback_method to the IOLoop timer to fire after deadline │ │ │ seconds. Returns a handle to the timeout

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │ +
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │
      • callback_method (method) – The callback method
      • │ │ │
      │ │ │
      Return type:

      str

      │ │ │ +
      Return type:

      str

      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ basic_nack
      │ │ │

      Specifies if the server supports basic.nack on the active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -514,15 +514,15 @@ │ │ │ numbers.

      │ │ │

      Return a Deferred that fires with an instance of a wrapper around the │ │ │ Pika Channel class.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:channel_number (int) – The channel number to use, defaults to the │ │ │ +
      Parameters:channel_number (int) – The channel number to use, defaults to the │ │ │ next available.
      │ │ │
      │ │ │ │ │ │
      │ │ │ @@ -533,16 +533,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • reply_code (int) – The code number for the close
      • │ │ │ -
      • reply_text (str) – The text reason for the close
      • │ │ │ +
      • reply_code (int) – The code number for the close
      • │ │ │ +
      • reply_text (str) – The text reason for the close
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -558,30 +558,30 @@ │ │ │ consumer_cancel_notify │ │ │

      Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ exchange_exchange_bindings
      │ │ │

      Specifies if the active connection supports exchange to exchange │ │ │ bindings.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -606,30 +606,30 @@ │ │ │
      │ │ │ publisher_confirms
      │ │ │

      Specifies if the active connection can use publisher confirmations.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ remove_timeout(timeout_id)
      │ │ │

      Remove the timeout from the IOLoop by the ID returned from │ │ │ add_timeout.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -637,15 +637,15 @@ │ │ │

      Alter the backpressure multiplier value. We set this to 10 by default. │ │ │ This value is used to raise warnings and trigger the backpressure │ │ │ callback.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:value (int) – The multiplier value to set
      Parameters:value (int) – The multiplier value to set
      │ │ │
      │ │ │ │ │ │ │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/channel.html │ │ │ @@ -68,16 +68,16 @@ │ │ │ should allow for the frame parameter to be passed in.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call
      • │ │ │ -
      • replies (list) – The replies to get a callback for
      • │ │ │ -
      • one_shot (bool) – Only handle the first type callback
      • │ │ │ +
      • replies (list) – The replies to get a callback for
      • │ │ │ +
      • one_shot (bool) – Only handle the first type callback
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -173,15 +173,15 @@ │ │ │ set of messages up to and including a specific message.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • delivery_tag (integer) – int/long The server-assigned delivery tag
      • │ │ │ -
      • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ +
      • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ “up to and including”, so that multiple messages │ │ │ can be acknowledged with a single method. If set │ │ │ to False, the delivery tag refers to a single │ │ │ message. If the multiple field is 1, and the │ │ │ delivery tag is zero, this indicates │ │ │ acknowledgement of all outstanding messages.
      • │ │ │
      │ │ │ @@ -207,20 +207,20 @@ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – Callback to call for a Basic.CancelOk │ │ │ response; MUST be None when nowait=True. MUST be callable when │ │ │ nowait=False.
      • │ │ │ -
      • consumer_tag (str) – Identifier for the consumer
      • │ │ │ -
      • nowait (bool) – Do not expect a Basic.CancelOk response
      • │ │ │ +
      • consumer_tag (str) – Identifier for the consumer
      • │ │ │ +
      • nowait (bool) – Do not expect a Basic.CancelOk response
      • │ │ │
      │ │ │
      Raises:

      ValueError

      │ │ │ +
      Raises:

      ValueError

      │ │ │
      │ │ │ │ │ │ │ │ │
      │ │ │ @@ -246,24 +246,24 @@ │ │ │
      body), where
      │ │ │

      channel: pika.Channel │ │ │ method: pika.spec.Basic.Deliver │ │ │ properties: pika.spec.BasicProperties │ │ │ body: str, unicode, or bytes (python 3.x)

      │ │ │ │ │ │ │ │ │ -
    • queue (str or unicode) – The queue to consume from
    • │ │ │ -
    • no_ack (bool) – if set to True, automatic acknowledgement mode will be used │ │ │ +
    • queue (str or unicode) – The queue to consume from
    • │ │ │ +
    • no_ack (bool) – if set to True, automatic acknowledgement mode will be used │ │ │ (see http://www.rabbitmq.com/confirms.html)
    • │ │ │ -
    • exclusive (bool) – Don’t allow other consumers on the queue
    • │ │ │ -
    • consumer_tag (str or unicode) – Specify your own consumer tag
    • │ │ │ -
    • arguments (dict) – Custom key/value pair arguments for the consumer
    • │ │ │ +
    • exclusive (bool) – Don’t allow other consumers on the queue
    • │ │ │ +
    • consumer_tag (str or unicode) – Specify your own consumer tag
    • │ │ │ +
    • arguments (dict) – Custom key/value pair arguments for the consumer
    • │ │ │ │ │ │
      Return type:

      str

      │ │ │ +
      Return type:

      str

      │ │ │
      │ │ │
      │ │ │ │ │ │
      │ │ │ @@ -283,16 +283,16 @@ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call with a message that has │ │ │ the signature callback(channel, method, properties, body), where: │ │ │ channel: pika.Channel │ │ │ method: pika.spec.Basic.GetOk │ │ │ properties: pika.spec.BasicProperties │ │ │ body: str, unicode, or bytes (python 3.x)
      • │ │ │ -
      • queue (str or unicode) – The queue to get a message from
      • │ │ │ -
      • no_ack (bool) – Tell the broker to not expect a reply
      • │ │ │ +
      • queue (str or unicode) – The queue to get a message from
      • │ │ │ +
      • no_ack (bool) – Tell the broker to not expect a reply
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -304,22 +304,22 @@ │ │ │ return untreatable messages to their original queue.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -333,20 +333,20 @@ │ │ │ For more information on basic_publish and what the parameters do, see:

      │ │ │

      http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.publish

      │ │ │
      Parameters:
        │ │ │
      • delivery-tag (integer) – int/long The server-assigned delivery tag
      • │ │ │ -
      • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ +
      • multiple (bool) – If set to True, the delivery tag is treated as │ │ │ “up to and including”, so that multiple messages │ │ │ can be acknowledged with a single method. If set │ │ │ to False, the delivery tag refers to a single │ │ │ message. If the multiple field is 1, and the │ │ │ delivery tag is zero, this indicates │ │ │ acknowledgement of all outstanding messages.
      • │ │ │ -
      • requeue (bool) – If requeue is true, the server will attempt to │ │ │ +
      • requeue (bool) – If requeue is true, the server will attempt to │ │ │ requeue the message. If requeue is false or the │ │ │ requeue attempt fails the messages are discarded or │ │ │ dead-lettered.
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • exchange (str or unicode) – The exchange to publish to
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ -
      • body (str or unicode) – The message body
      • │ │ │ +
      • exchange (str or unicode) – The exchange to publish to
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ +
      • body (str or unicode) – The message body
      • │ │ │
      • properties (pika.spec.BasicProperties) – Basic.properties
      • │ │ │ -
      • mandatory (bool) – The mandatory flag
      • │ │ │ -
      • immediate (bool) – The immediate flag
      • │ │ │ +
      • mandatory (bool) – The mandatory flag
      • │ │ │ +
      • immediate (bool) – The immediate flag
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -361,32 +361,32 @@ │ │ │ sent down the channel. Prefetching gives a performance improvement.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call for Basic.QosOk response
      • │ │ │ -
      • prefetch_size (int) – This field specifies the prefetch window │ │ │ +
      • prefetch_size (int) – This field specifies the prefetch window │ │ │ size. 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.
      • │ │ │ -
      • prefetch_count (int) – Specifies a prefetch window in terms of whole │ │ │ +
      • prefetch_count (int) – 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.
      • │ │ │ -
      • all_channels (bool) – Should the QoS apply to all channels
      • │ │ │ +
      • all_channels (bool) – Should the QoS apply to all channels
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -399,15 +399,15 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -422,15 +422,15 @@ │ │ │ or return untreatable messages to their original queue.

      │ │ │
      Parameters:
        │ │ │
      • callback (callable) – Callback to call when receiving │ │ │ Basic.RecoverOk
      • │ │ │ -
      • requeue (bool) – If False, the message will be redelivered to the │ │ │ +
      • requeue (bool) – If False, the message will be redelivered to the │ │ │ original recipient. If True, the server will │ │ │ attempt to requeue the message, potentially then │ │ │ delivering it to an alternative subscriber.
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • delivery-tag (integer) – int/long The server-assigned delivery tag
      • │ │ │ -
      • requeue (bool) – If requeue is true, the server will attempt to │ │ │ +
      • requeue (bool) – If requeue is true, the server will attempt to │ │ │ requeue the message. If requeue is false or the │ │ │ requeue attempt fails the messages are discarded or │ │ │ dead-lettered.
      • │ │ │
      │ │ │
      Raises:

      TypeError

      │ │ │ @@ -447,16 +447,16 @@ │ │ │

      If channel is OPENING, transition to CLOSING and suppress the incoming │ │ │ Channel.OpenOk, if any.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • reply_code (int) – The reason code to send to broker
      • │ │ │ -
      • reply_text (str) – The reason text to send to broker
      • │ │ │ +
      • reply_code (int) – The reason code to send to broker
      • │ │ │ +
      • reply_text (str) – The reason text to send to broker
      • │ │ │
      │ │ │
      Raises: │ │ │ @@ -481,15 +481,15 @@ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback for delivery confirmations that │ │ │ has the following signature: callback(pika.frame.Method), where │ │ │ method_frame contains either method spec.Basic.Ack or │ │ │ spec.Basic.Nack.
      • │ │ │ -
      • nowait (bool) – Do not send a reply frame (Confirm.SelectOk)
      • │ │ │ +
      • nowait (bool) – Do not send a reply frame (Confirm.SelectOk)
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -497,15 +497,15 @@ │ │ │
      │ │ │ consumer_tags
      │ │ │

      Property method that returns a list of currently active consumers

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:list
      Return type:list
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -514,19 +514,19 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call on Exchange.BindOk; MUST │ │ │ be None when nowait=True
      • │ │ │ -
      • destination (str or unicode) – The destination exchange to bind
      • │ │ │ -
      • source (str or unicode) – The source exchange to bind to
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ -
      • nowait (bool) – Do not wait for an Exchange.BindOk
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │ +
      • destination (str or unicode) – The destination exchange to bind
      • │ │ │ +
      • source (str or unicode) – The source exchange to bind to
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ +
      • nowait (bool) – Do not wait for an Exchange.BindOk
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -543,25 +543,25 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – Call this method on Exchange.DeclareOk; MUST │ │ │ be None when nowait=True
      • │ │ │ -
      • exchange (str or unicode │ │ │ +
      • exchange (str or unicode │ │ │ sequence of these characters: letters, │ │ │ digits, hyphen, underscore, period, or │ │ │ colon.) – The exchange name consists of a non-empty
      • │ │ │ -
      • exchange_type (str) – The exchange type to use
      • │ │ │ -
      • passive (bool) – Perform a declare or just check to see if it exists
      • │ │ │ -
      • durable (bool) – Survive a reboot of RabbitMQ
      • │ │ │ -
      • auto_delete (bool) – Remove when no more queues are bound to it
      • │ │ │ -
      • internal (bool) – Can only be published to by other exchanges
      • │ │ │ -
      • nowait (bool) – Do not expect an Exchange.DeclareOk response
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the exchange
      • │ │ │ +
      • exchange_type (str) – The exchange type to use
      • │ │ │ +
      • passive (bool) – Perform a declare or just check to see if it exists
      • │ │ │ +
      • durable (bool) – Survive a reboot of RabbitMQ
      • │ │ │ +
      • auto_delete (bool) – Remove when no more queues are bound to it
      • │ │ │ +
      • internal (bool) – Can only be published to by other exchanges
      • │ │ │ +
      • nowait (bool) – Do not expect an Exchange.DeclareOk response
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the exchange
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -572,17 +572,17 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The function to call on Exchange.DeleteOk; │ │ │ MUST be None when nowait=True.
      • │ │ │ -
      • exchange (str or unicode) – The exchange name
      • │ │ │ -
      • if_unused (bool) – only delete if the exchange is unused
      • │ │ │ -
      • nowait (bool) – Do not wait for an Exchange.DeleteOk
      • │ │ │ +
      • exchange (str or unicode) – The exchange name
      • │ │ │ +
      • if_unused (bool) – only delete if the exchange is unused
      • │ │ │ +
      • nowait (bool) – Do not wait for an Exchange.DeleteOk
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -593,19 +593,19 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call on Exchange.UnbindOk; │ │ │ MUST be None when nowait=True.
      • │ │ │ -
      • destination (str or unicode) – The destination exchange to unbind
      • │ │ │ -
      • source (str or unicode) – The source exchange to unbind from
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to unbind
      • │ │ │ -
      • nowait (bool) – Do not wait for an Exchange.UnbindOk
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │ +
      • destination (str or unicode) – The destination exchange to unbind
      • │ │ │ +
      • source (str or unicode) – The source exchange to unbind from
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to unbind
      • │ │ │ +
      • nowait (bool) – Do not wait for an Exchange.UnbindOk
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -619,15 +619,15 @@ │ │ │

      http://www.rabbitmq.com/amqp-0-9-1-reference.html#channel.flow

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call upon completion
      • │ │ │ -
      • active (bool) – Turn flow on or off
      • │ │ │ +
      • active (bool) – Turn flow on or off
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -635,44 +635,44 @@ │ │ │
      │ │ │ is_closed
      │ │ │

      Returns True if the channel is closed.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ is_closing
      │ │ │

      Returns True if client-initiated closing of the channel is in │ │ │ progress.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ is_open
      │ │ │

      Returns True if the channel is open.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -687,19 +687,19 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call on Queue.BindOk; │ │ │ MUST be None when nowait=True.
      • │ │ │ -
      • queue (str or unicode) – The queue to bind to the exchange
      • │ │ │ -
      • exchange (str or unicode) – The source exchange to bind to
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ -
      • nowait (bool) – Do not wait for a Queue.BindOk
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │ +
      • queue (str or unicode) – The queue to bind to the exchange
      • │ │ │ +
      • exchange (str or unicode) – The source exchange to bind to
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to bind on
      • │ │ │ +
      • nowait (bool) – Do not wait for a Queue.BindOk
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -714,21 +714,21 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – callback(pika.frame.Method) for method │ │ │ Queue.DeclareOk; MUST be None when nowait=True.
      • │ │ │ -
      • queue (str or unicode) – The queue name
      • │ │ │ -
      • passive (bool) – Only check to see if the queue exists
      • │ │ │ -
      • durable (bool) – Survive reboots of the broker
      • │ │ │ -
      • exclusive (bool) – Only allow access by the current connection
      • │ │ │ -
      • auto_delete (bool) – Delete after consumer cancels or disconnects
      • │ │ │ -
      • nowait (bool) – Do not wait for a Queue.DeclareOk
      • │ │ │ -
      • arguments (dict) – Custom key/value arguments for the queue
      • │ │ │ +
      • queue (str or unicode) – The queue name
      • │ │ │ +
      • passive (bool) – Only check to see if the queue exists
      • │ │ │ +
      • durable (bool) – Survive reboots of the broker
      • │ │ │ +
      • exclusive (bool) – Only allow access by the current connection
      • │ │ │ +
      • auto_delete (bool) – Delete after consumer cancels or disconnects
      • │ │ │ +
      • nowait (bool) – Do not wait for a Queue.DeclareOk
      • │ │ │ +
      • arguments (dict) – Custom key/value arguments for the queue
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -739,18 +739,18 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call on Queue.DeleteOk; │ │ │ MUST be None when nowait=True.
      • │ │ │ -
      • queue (str or unicode) – The queue to delete
      • │ │ │ -
      • if_unused (bool) – only delete if it’s unused
      • │ │ │ -
      • if_empty (bool) – only delete if the queue is empty
      • │ │ │ -
      • nowait (bool) – Do not wait for a Queue.DeleteOk
      • │ │ │ +
      • queue (str or unicode) – The queue to delete
      • │ │ │ +
      • if_unused (bool) – only delete if it’s unused
      • │ │ │ +
      • if_empty (bool) – only delete if the queue is empty
      • │ │ │ +
      • nowait (bool) – Do not wait for a Queue.DeleteOk
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -761,16 +761,16 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call on Queue.PurgeOk; │ │ │ MUST be None when nowait=True.
      • │ │ │ -
      • queue (str or unicode) – The queue to purge
      • │ │ │ -
      • nowait (bool) – Do not expect a Queue.PurgeOk response
      • │ │ │ +
      • queue (str or unicode) – The queue to purge
      • │ │ │ +
      • nowait (bool) – Do not expect a Queue.PurgeOk response
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -780,18 +780,18 @@ │ │ │

      Unbind a queue from an exchange.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback (callable) – The callback to call on Queue.UnbindOk
      • │ │ │ -
      • queue (str or unicode) – The queue to unbind from the exchange
      • │ │ │ -
      • exchange (str or unicode) – The source exchange to bind from
      • │ │ │ -
      • routing_key (str or unicode) – The routing key to unbind
      • │ │ │ -
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │ +
      • queue (str or unicode) – The queue to unbind from the exchange
      • │ │ │ +
      • exchange (str or unicode) – The source exchange to bind from
      • │ │ │ +
      • routing_key (str or unicode) – The routing key to unbind
      • │ │ │ +
      • arguments (dict) – Custom key/value pair arguments for the binding
      • │ │ │
      │ │ │
      │ │ │
      │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/connection.html │ │ │ @@ -166,15 +166,15 @@ │ │ │ connect, and an optional error message.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │
      • callback_method (method) – Callback to call when can’t connect
      • │ │ │ -
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │ +
      • remove_default (bool) – Remove default exception raising callback
      • │ │ │
      │ │ │
      │ │ │ │ │ │ │ │ │ @@ -185,15 +185,15 @@ │ │ │ specified number of seconds have elapsed, using a timer, or a │ │ │ thread, or similar.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │ +
      • deadline (int) – The number of seconds to wait to call callback
      • │ │ │
      • callback_method (method) – The callback method
      • │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -202,15 +202,15 @@ │ │ │
      │ │ │ basic_nack
      │ │ │

      Specifies if the server supports basic.nack on the active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -221,15 +221,15 @@ │ │ │ numbers.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ @@ -245,16 +245,16 @@ │ │ │ have active consumers will attempt to send a Basic.Cancel to RabbitMQ │ │ │ to cleanly stop the delivery of messages prior to closing the channel.

      │ │ │
      Parameters:
        │ │ │
      • on_open_callback (method) – The callback when the channel is opened
      • │ │ │ -
      • channel_number (int) – The channel number to use, defaults to the │ │ │ +
      • channel_number (int) – The channel number to use, defaults to the │ │ │ next available.
      • │ │ │
      │ │ │
      Return type:

      pika.channel.Channel

      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • reply_code (int) – The code number for the close
      • │ │ │ -
      • reply_text (str) – The text reason for the close
      • │ │ │ +
      • reply_code (int) – The code number for the close
      • │ │ │ +
      • reply_text (str) – The text reason for the close
      • │ │ │
      │ │ │
      │ │ │
      │ │ │ │ │ │ @@ -270,30 +270,30 @@ │ │ │ consumer_cancel_notify │ │ │

      Specifies if the server supports consumer cancel notification on the │ │ │ active connection.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ exchange_exchange_bindings
      │ │ │

      Specifies if the active connection supports exchange to exchange │ │ │ bindings.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -318,29 +318,29 @@ │ │ │
      │ │ │ publisher_confirms
      │ │ │

      Specifies if the active connection can use publisher confirmations.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Return type:bool
      Return type:bool
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ remove_timeout(timeout_id)
      │ │ │

      Adapters should override: Remove a timeout

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:timeout_id (str) – The timeout id to remove
      Parameters:timeout_id (str) – The timeout id to remove
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -348,15 +348,15 @@ │ │ │

      Alter the backpressure multiplier value. We set this to 10 by default. │ │ │ This value is used to raise warnings and trigger the backpressure │ │ │ callback.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:value (int) – The multiplier value to set
      Parameters:value (int) – The multiplier value to set
      │ │ │
      │ │ │ │ │ │ │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/credentials.html │ │ │ @@ -72,17 +72,17 @@ │ │ │

      If you pass True to erase_on_connect the credentials will not be stored │ │ │ in memory after the Connection attempt has been made.

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
      Parameters:
        │ │ │ -
      • username (str) – The username to authenticate with
      • │ │ │ -
      • password (str) – The password to authenticate with
      • │ │ │ -
      • erase_on_connect (bool) – erase credentials on connect.
      • │ │ │ +
      • username (str) – The username to authenticate with
      • │ │ │ +
      • password (str) – The password to authenticate with
      • │ │ │ +
      • erase_on_connect (bool) – erase credentials on connect.
      • │ │ │
      │ │ │
      │ │ │
      │ │ │
      │ │ │ @@ -96,15 +96,15 @@ │ │ │

      Validate that this type of authentication is supported

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:start (spec.Connection.Start) – Connection.Start method
      Return type:tuple(str|None, str|None)
      Return type:tuple(str|None, str|None)
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ @@ -128,15 +128,15 @@ │ │ │

      Validate that this type of authentication is supported

      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:start (spec.Connection.Start) – Connection.Start method
      Return type:tuple(str or None, str or None)
      Return type:tuple(str or None, str or None)
      │ │ │
      │ │ │ │ │ │ │ │ ├── ./usr/share/doc/python-pika-doc/html/modules/parameters.html │ │ │ @@ -103,15 +103,15 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:max preferred number of channels. Defaults to │ │ │ DEFAULT_CHANNEL_MAX.
      Return type:int
      Return type:int
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -178,30 +178,30 @@ │ │ │
      Returns:desired connection heartbeat timeout for negotiation or │ │ │ None to accept broker’s value. 0 turns heartbeat off. Defaults to │ │ │ DEFAULT_HEARTBEAT_TIMEOUT.
      Return type:integer, float, or None
      Return type:integer, float, or None
      │ │ │ │ │ │ │ │ │
      │ │ │
      │ │ │ host
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:hostname or ip address of broker. Defaults to DEFAULT_HOST.
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -209,15 +209,15 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:locale value to pass to broker; e.g., ‘en_US’. Defaults to │ │ │ DEFAULT_LOCALE.
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -225,15 +225,15 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:port number of broker’s listening socket. Defaults to │ │ │ DEFAULT_PORT.
      Return type:int
      Return type:int
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -241,30 +241,30 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:interval between socket connection attempts; see also │ │ │ connection_attempts. Defaults to DEFAULT_RETRY_DELAY.
      Return type:float
      Return type:float
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ socket_timeout
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:socket timeout value. Defaults to DEFAULT_SOCKET_TIMEOUT.
      Return type:float
      Return type:float
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -406,15 +406,15 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Parameters:url (str) – The AMQP URL to connect to
      Parameters:url (str) – The AMQP URL to connect to
      │ │ │
      │ │ │
      │ │ │ backpressure_detection
      │ │ │
      │ │ │ @@ -448,15 +448,15 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:max preferred number of channels. Defaults to │ │ │ DEFAULT_CHANNEL_MAX.
      Return type:int
      Return type:int
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -523,30 +523,30 @@ │ │ │
      Returns:desired connection heartbeat timeout for negotiation or │ │ │ None to accept broker’s value. 0 turns heartbeat off. Defaults to │ │ │ DEFAULT_HEARTBEAT_TIMEOUT.
      Return type:integer, float, or None
      Return type:integer, float, or None
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ host
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:hostname or ip address of broker. Defaults to DEFAULT_HOST.
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -554,15 +554,15 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:locale value to pass to broker; e.g., ‘en_US’. Defaults to │ │ │ DEFAULT_LOCALE.
      Return type:str
      Return type:str
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -570,15 +570,15 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:port number of broker’s listening socket. Defaults to │ │ │ DEFAULT_PORT.
      Return type:int
      Return type:int
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ @@ -586,30 +586,30 @@ │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:interval between socket connection attempts; see also │ │ │ connection_attempts. Defaults to DEFAULT_RETRY_DELAY.
      Return type:float
      Return type:float
      │ │ │
      │ │ │ │ │ │
      │ │ │
      │ │ │ socket_timeout
      │ │ │
      │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ + │ │ │ │ │ │ │ │ │
      Returns:socket timeout value. Defaults to DEFAULT_SOCKET_TIMEOUT.
      Return type:float
      Return type:float
      │ │ │
      │ │ │ │ │ │
      │ │ │