spec

Note

This class is not intended for use by those using Pika in their applications. This documentation is for those who are extending Pika or otherwise working on the driver itself.

spec.py is an auto-generated python module which is created by the codegen.py application. It contains all of the information about the protocol that is required for Pika to communicate with RabbitMQ.

class pika.spec.Connection[source]
INDEX = 10
NAME = 'Connection'
class Start(version_major=0, version_minor=9, server_properties=None, mechanisms='PLAIN', locales='en_US')[source]
INDEX = 655370
NAME = 'Connection.Start'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.StartOk(client_properties=None, mechanism='PLAIN', response=None, locale='en_US')[source]
INDEX = 655371
NAME = 'Connection.StartOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.Secure(challenge=None)[source]
INDEX = 655380
NAME = 'Connection.Secure'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.SecureOk(response=None)[source]
INDEX = 655381
NAME = 'Connection.SecureOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.Tune(channel_max=0, frame_max=0, heartbeat=0)[source]
INDEX = 655390
NAME = 'Connection.Tune'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.TuneOk(channel_max=0, frame_max=0, heartbeat=0)[source]
INDEX = 655391
NAME = 'Connection.TuneOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.Open(virtual_host='/', capabilities='', insist=False)[source]
INDEX = 655400
NAME = 'Connection.Open'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.OpenOk(known_hosts='')[source]
INDEX = 655401
NAME = 'Connection.OpenOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.Close(reply_code=None, reply_text='', class_id=None, method_id=None)[source]
INDEX = 655410
NAME = 'Connection.Close'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Connection.CloseOk[source]
INDEX = 655411
NAME = 'Connection.CloseOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Channel[source]
INDEX = 20
NAME = 'Channel'
class Open(out_of_band='')[source]
INDEX = 1310730
NAME = 'Channel.Open'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Channel.OpenOk(channel_id='')[source]
INDEX = 1310731
NAME = 'Channel.OpenOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Channel.Flow(active=None)[source]
INDEX = 1310740
NAME = 'Channel.Flow'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Channel.FlowOk(active=None)[source]
INDEX = 1310741
NAME = 'Channel.FlowOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Channel.Close(reply_code=None, reply_text='', class_id=None, method_id=None)[source]
INDEX = 1310760
NAME = 'Channel.Close'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Channel.CloseOk[source]
INDEX = 1310761
NAME = 'Channel.CloseOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Access[source]
INDEX = 30
NAME = 'Access'
class Request(realm='/data', exclusive=False, passive=True, active=True, write=True, read=True)[source]
INDEX = 1966090
NAME = 'Access.Request'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Access.RequestOk(ticket=1)[source]
INDEX = 1966091
NAME = 'Access.RequestOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Exchange[source]
INDEX = 40
NAME = 'Exchange'
class Declare(ticket=0, exchange=None, type='direct', passive=False, durable=False, auto_delete=False, internal=False, nowait=False, arguments={})[source]
INDEX = 2621450
NAME = 'Exchange.Declare'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.DeclareOk[source]
INDEX = 2621451
NAME = 'Exchange.DeclareOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.Delete(ticket=0, exchange=None, if_unused=False, nowait=False)[source]
INDEX = 2621460
NAME = 'Exchange.Delete'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.DeleteOk[source]
INDEX = 2621461
NAME = 'Exchange.DeleteOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.Bind(ticket=0, destination=None, source=None, routing_key='', nowait=False, arguments={})[source]
INDEX = 2621470
NAME = 'Exchange.Bind'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.BindOk[source]
INDEX = 2621471
NAME = 'Exchange.BindOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.Unbind(ticket=0, destination=None, source=None, routing_key='', nowait=False, arguments={})[source]
INDEX = 2621480
NAME = 'Exchange.Unbind'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Exchange.UnbindOk[source]
INDEX = 2621491
NAME = 'Exchange.UnbindOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Queue[source]
INDEX = 50
NAME = 'Queue'
class Declare(ticket=0, queue='', passive=False, durable=False, exclusive=False, auto_delete=False, nowait=False, arguments={})[source]
INDEX = 3276810
NAME = 'Queue.Declare'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.DeclareOk(queue=None, message_count=None, consumer_count=None)[source]
INDEX = 3276811
NAME = 'Queue.DeclareOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.Bind(ticket=0, queue='', exchange=None, routing_key='', nowait=False, arguments={})[source]
INDEX = 3276820
NAME = 'Queue.Bind'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.BindOk[source]
INDEX = 3276821
NAME = 'Queue.BindOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.Purge(ticket=0, queue='', nowait=False)[source]
INDEX = 3276830
NAME = 'Queue.Purge'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.PurgeOk(message_count=None)[source]
INDEX = 3276831
NAME = 'Queue.PurgeOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.Delete(ticket=0, queue='', if_unused=False, if_empty=False, nowait=False)[source]
INDEX = 3276840
NAME = 'Queue.Delete'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.DeleteOk(message_count=None)[source]
INDEX = 3276841
NAME = 'Queue.DeleteOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.Unbind(ticket=0, queue='', exchange=None, routing_key='', arguments={})[source]
INDEX = 3276850
NAME = 'Queue.Unbind'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Queue.UnbindOk[source]
INDEX = 3276851
NAME = 'Queue.UnbindOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Basic[source]
INDEX = 60
NAME = 'Basic'
class Qos(prefetch_size=0, prefetch_count=0, global_=False)[source]
INDEX = 3932170
NAME = 'Basic.Qos'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.QosOk[source]
INDEX = 3932171
NAME = 'Basic.QosOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Consume(ticket=0, queue='', consumer_tag='', no_local=False, no_ack=False, exclusive=False, nowait=False, arguments={})[source]
INDEX = 3932180
NAME = 'Basic.Consume'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.ConsumeOk(consumer_tag=None)[source]
INDEX = 3932181
NAME = 'Basic.ConsumeOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Cancel(consumer_tag=None, nowait=False)[source]
INDEX = 3932190
NAME = 'Basic.Cancel'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.CancelOk(consumer_tag=None)[source]
INDEX = 3932191
NAME = 'Basic.CancelOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Publish(ticket=0, exchange='', routing_key='', mandatory=False, immediate=False)[source]
INDEX = 3932200
NAME = 'Basic.Publish'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Return(reply_code=None, reply_text='', exchange=None, routing_key=None)[source]
INDEX = 3932210
NAME = 'Basic.Return'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Deliver(consumer_tag=None, delivery_tag=None, redelivered=False, exchange=None, routing_key=None)[source]
INDEX = 3932220
NAME = 'Basic.Deliver'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Get(ticket=0, queue='', no_ack=False)[source]
INDEX = 3932230
NAME = 'Basic.Get'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.GetOk(delivery_tag=None, redelivered=False, exchange=None, routing_key=None, message_count=None)[source]
INDEX = 3932231
NAME = 'Basic.GetOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.GetEmpty(cluster_id='')[source]
INDEX = 3932232
NAME = 'Basic.GetEmpty'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Ack(delivery_tag=0, multiple=False)[source]
INDEX = 3932240
NAME = 'Basic.Ack'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Reject(delivery_tag=None, requeue=True)[source]
INDEX = 3932250
NAME = 'Basic.Reject'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.RecoverAsync(requeue=False)[source]
INDEX = 3932260
NAME = 'Basic.RecoverAsync'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Recover(requeue=False)[source]
INDEX = 3932270
NAME = 'Basic.Recover'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.RecoverOk[source]
INDEX = 3932271
NAME = 'Basic.RecoverOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Basic.Nack(delivery_tag=0, multiple=False, requeue=True)[source]
INDEX = 3932280
NAME = 'Basic.Nack'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Tx[source]
INDEX = 90
NAME = 'Tx'
class Select[source]
INDEX = 5898250
NAME = 'Tx.Select'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Tx.SelectOk[source]
INDEX = 5898251
NAME = 'Tx.SelectOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Tx.Commit[source]
INDEX = 5898260
NAME = 'Tx.Commit'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Tx.CommitOk[source]
INDEX = 5898261
NAME = 'Tx.CommitOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Tx.Rollback[source]
INDEX = 5898270
NAME = 'Tx.Rollback'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Tx.RollbackOk[source]
INDEX = 5898271
NAME = 'Tx.RollbackOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.Confirm[source]
INDEX = 85
NAME = 'Confirm'
class Select(nowait=False)[source]
INDEX = 5570570
NAME = 'Confirm.Select'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class Confirm.SelectOk[source]
INDEX = 5570571
NAME = 'Confirm.SelectOk'
synchronous
decode(encoded, offset=0)[source]
encode()[source]
_set_content(properties, body)

If the method is a content frame, set the properties and body to be carried as attributes of the class.

Parameters:
  • properties (pika.frame.Properties) – AMQP Basic Properties
  • body (str|unicode) – The message body
get_body()

Return the message body if it is set.

Return type:str|unicode
get_properties()

Return the properties if they are set.

Return type:pika.frame.Properties
class pika.spec.BasicProperties(content_type=None, content_encoding=None, headers=None, delivery_mode=None, priority=None, correlation_id=None, reply_to=None, expiration=None, message_id=None, timestamp=None, type=None, user_id=None, app_id=None, cluster_id=None)[source]
CLASS

alias of Basic

INDEX = 60
NAME = 'BasicProperties'
FLAG_CONTENT_TYPE = 32768
FLAG_CONTENT_ENCODING = 16384
FLAG_HEADERS = 8192
FLAG_DELIVERY_MODE = 4096
FLAG_PRIORITY = 2048
FLAG_CORRELATION_ID = 1024
FLAG_REPLY_TO = 512
FLAG_EXPIRATION = 256
FLAG_MESSAGE_ID = 128
FLAG_TIMESTAMP = 64
FLAG_TYPE = 32
FLAG_USER_ID = 16
FLAG_APP_ID = 8
FLAG_CLUSTER_ID = 4
decode(encoded, offset=0)[source]
encode()[source]
pika.spec.has_content(methodNumber)[source]