pika.spec

class pika.spec.Access

INDEX = 30

NAME = 'Access'

class Request(realm='/data', exclusive=False, passive=True, active=True, write=True, read=True)

INDEX = 1966090

NAME = 'Access.Request'

decode(encoded, offset=0)

encode()

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

synchronous

class Access.RequestOk(ticket=1)

INDEX = 1966091

NAME = 'Access.RequestOk'

decode(encoded, offset=0)

encode()

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

synchronous

class pika.spec.Basic

class Ack(delivery_tag=0, multiple=False)

INDEX = 3932240

NAME = 'Basic.Ack'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Cancel(consumer_tag=None, nowait=False)

INDEX = 3932190

NAME = 'Basic.Cancel'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.CancelOk(consumer_tag=None)

INDEX = 3932191

NAME = 'Basic.CancelOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Consume(ticket=0, queue='', consumer_tag='', no_local=False, no_ack=False, exclusive=False, nowait=False, arguments={})

INDEX = 3932180

NAME = 'Basic.Consume'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.ConsumeOk(consumer_tag=None)

INDEX = 3932181

NAME = 'Basic.ConsumeOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Deliver(consumer_tag=None, delivery_tag=None, redelivered=False, exchange=None, routing_key=None)

INDEX = 3932220

NAME = 'Basic.Deliver'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Get(ticket=0, queue='', no_ack=False)

INDEX = 3932230

NAME = 'Basic.Get'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.GetEmpty(cluster_id='')

INDEX = 3932232

NAME = 'Basic.GetEmpty'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.GetOk(delivery_tag=None, redelivered=False, exchange=None, routing_key=None, message_count=None)

INDEX = 3932231

NAME = 'Basic.GetOk'

decode(encoded, offset=0)

encode()

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

synchronous

Basic.INDEX = 60

Basic.NAME = 'Basic'

class Basic.Nack(delivery_tag=0, multiple=False, requeue=True)

INDEX = 3932280

NAME = 'Basic.Nack'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Publish(ticket=0, exchange='', routing_key='', mandatory=False, immediate=False)

INDEX = 3932200

NAME = 'Basic.Publish'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Qos(prefetch_size=0, prefetch_count=0, global_=False)

INDEX = 3932170

NAME = 'Basic.Qos'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.QosOk

INDEX = 3932171

NAME = 'Basic.QosOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Recover(requeue=False)

INDEX = 3932270

NAME = 'Basic.Recover'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.RecoverAsync(requeue=False)

INDEX = 3932260

NAME = 'Basic.RecoverAsync'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.RecoverOk

INDEX = 3932271

NAME = 'Basic.RecoverOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Reject(delivery_tag=None, requeue=True)

INDEX = 3932250

NAME = 'Basic.Reject'

decode(encoded, offset=0)

encode()

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

synchronous

class Basic.Return(reply_code=None, reply_text='', exchange=None, routing_key=None)

INDEX = 3932210

NAME = 'Basic.Return'

decode(encoded, offset=0)

encode()

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

synchronous

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)

CLASS

alias of Basic

FLAG_APP_ID = 8

FLAG_CLUSTER_ID = 4

FLAG_CONTENT_ENCODING = 16384

FLAG_CONTENT_TYPE = 32768

FLAG_CORRELATION_ID = 1024

FLAG_DELIVERY_MODE = 4096

FLAG_EXPIRATION = 256

FLAG_HEADERS = 8192

FLAG_MESSAGE_ID = 128

FLAG_PRIORITY = 2048

FLAG_REPLY_TO = 512

FLAG_TIMESTAMP = 64

FLAG_TYPE = 32

FLAG_USER_ID = 16

INDEX = 60

NAME = 'BasicProperties'

decode(encoded, offset=0)

encode()

class pika.spec.Channel

class Close(reply_code=None, reply_text='', class_id=None, method_id=None)

INDEX = 1310760

NAME = 'Channel.Close'

decode(encoded, offset=0)

encode()

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

synchronous

class Channel.CloseOk

INDEX = 1310761

NAME = 'Channel.CloseOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Channel.Flow(active=None)

INDEX = 1310740

NAME = 'Channel.Flow'

decode(encoded, offset=0)

encode()

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

synchronous

class Channel.FlowOk(active=None)

INDEX = 1310741

NAME = 'Channel.FlowOk'

decode(encoded, offset=0)

encode()

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

synchronous

Channel.INDEX = 20

Channel.NAME = 'Channel'

class Channel.Open(out_of_band='')

INDEX = 1310730

NAME = 'Channel.Open'

decode(encoded, offset=0)

encode()

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

synchronous

class Channel.OpenOk(channel_id='')

INDEX = 1310731

NAME = 'Channel.OpenOk'

decode(encoded, offset=0)

encode()

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

synchronous

class pika.spec.Confirm

INDEX = 85

NAME = 'Confirm'

class Select(nowait=False)

INDEX = 5570570

NAME = 'Confirm.Select'

decode(encoded, offset=0)

encode()

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

synchronous

class Confirm.SelectOk

INDEX = 5570571

NAME = 'Confirm.SelectOk'

decode(encoded, offset=0)

encode()

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

synchronous

class pika.spec.Connection

class Blocked(reason='')

INDEX = 655420

NAME = 'Connection.Blocked'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.Close(reply_code=None, reply_text='', class_id=None, method_id=None)

INDEX = 655410

NAME = 'Connection.Close'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.CloseOk

INDEX = 655411

NAME = 'Connection.CloseOk'

decode(encoded, offset=0)

encode()

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

synchronous

Connection.INDEX = 10

Connection.NAME = 'Connection'

class Connection.Open(virtual_host='/', capabilities='', insist=False)

INDEX = 655400

NAME = 'Connection.Open'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.OpenOk(known_hosts='')

INDEX = 655401

NAME = 'Connection.OpenOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.Secure(challenge=None)

INDEX = 655380

NAME = 'Connection.Secure'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.SecureOk(response=None)

INDEX = 655381

NAME = 'Connection.SecureOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.Start(version_major=0, version_minor=9, server_properties=None, mechanisms='PLAIN', locales='en_US')

INDEX = 655370

NAME = 'Connection.Start'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.StartOk(client_properties=None, mechanism='PLAIN', response=None, locale='en_US')

INDEX = 655371

NAME = 'Connection.StartOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.Tune(channel_max=0, frame_max=0, heartbeat=0)

INDEX = 655390

NAME = 'Connection.Tune'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.TuneOk(channel_max=0, frame_max=0, heartbeat=0)

INDEX = 655391

NAME = 'Connection.TuneOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Connection.Unblocked

INDEX = 655421

NAME = 'Connection.Unblocked'

decode(encoded, offset=0)

encode()

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

synchronous

class pika.spec.Exchange

class Bind(ticket=0, destination=None, source=None, routing_key='', nowait=False, arguments={})

INDEX = 2621470

NAME = 'Exchange.Bind'

decode(encoded, offset=0)

encode()

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

synchronous

class Exchange.BindOk

INDEX = 2621471

NAME = 'Exchange.BindOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Exchange.Declare(ticket=0, exchange=None, type='direct', passive=False, durable=False, auto_delete=False, internal=False, nowait=False, arguments={})

INDEX = 2621450

NAME = 'Exchange.Declare'

decode(encoded, offset=0)

encode()

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

synchronous

class Exchange.DeclareOk

INDEX = 2621451

NAME = 'Exchange.DeclareOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Exchange.Delete(ticket=0, exchange=None, if_unused=False, nowait=False)

INDEX = 2621460

NAME = 'Exchange.Delete'

decode(encoded, offset=0)

encode()

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

synchronous

class Exchange.DeleteOk

INDEX = 2621461

NAME = 'Exchange.DeleteOk'

decode(encoded, offset=0)

encode()

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

synchronous

Exchange.INDEX = 40

Exchange.NAME = 'Exchange'

class Exchange.Unbind(ticket=0, destination=None, source=None, routing_key='', nowait=False, arguments={})

INDEX = 2621480

NAME = 'Exchange.Unbind'

decode(encoded, offset=0)

encode()

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

synchronous

class Exchange.UnbindOk

INDEX = 2621491

NAME = 'Exchange.UnbindOk'

decode(encoded, offset=0)

encode()

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

synchronous

class pika.spec.Queue

class Bind(ticket=0, queue='', exchange=None, routing_key='', nowait=False, arguments={})

INDEX = 3276820

NAME = 'Queue.Bind'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.BindOk

INDEX = 3276821

NAME = 'Queue.BindOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.Declare(ticket=0, queue='', passive=False, durable=False, exclusive=False, auto_delete=False, nowait=False, arguments={})

INDEX = 3276810

NAME = 'Queue.Declare'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.DeclareOk(queue=None, message_count=None, consumer_count=None)

INDEX = 3276811

NAME = 'Queue.DeclareOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.Delete(ticket=0, queue='', if_unused=False, if_empty=False, nowait=False)

INDEX = 3276840

NAME = 'Queue.Delete'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.DeleteOk(message_count=None)

INDEX = 3276841

NAME = 'Queue.DeleteOk'

decode(encoded, offset=0)

encode()

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

synchronous

Queue.INDEX = 50

Queue.NAME = 'Queue'

class Queue.Purge(ticket=0, queue='', nowait=False)

INDEX = 3276830

NAME = 'Queue.Purge'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.PurgeOk(message_count=None)

INDEX = 3276831

NAME = 'Queue.PurgeOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.Unbind(ticket=0, queue='', exchange=None, routing_key='', arguments={})

INDEX = 3276850

NAME = 'Queue.Unbind'

decode(encoded, offset=0)

encode()

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

synchronous

class Queue.UnbindOk

INDEX = 3276851

NAME = 'Queue.UnbindOk'

decode(encoded, offset=0)

encode()

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

synchronous

class pika.spec.Tx

class Commit

INDEX = 5898260

NAME = 'Tx.Commit'

decode(encoded, offset=0)

encode()

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

synchronous

class Tx.CommitOk

INDEX = 5898261

NAME = 'Tx.CommitOk'

decode(encoded, offset=0)

encode()

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

synchronous

Tx.INDEX = 90

Tx.NAME = 'Tx'

class Tx.Rollback

INDEX = 5898270

NAME = 'Tx.Rollback'

decode(encoded, offset=0)

encode()

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

synchronous

class Tx.RollbackOk

INDEX = 5898271

NAME = 'Tx.RollbackOk'

decode(encoded, offset=0)

encode()

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

synchronous

class Tx.Select

INDEX = 5898250

NAME = 'Tx.Select'

decode(encoded, offset=0)

encode()

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

synchronous

class Tx.SelectOk

INDEX = 5898251

NAME = 'Tx.SelectOk'

decode(encoded, offset=0)

encode()

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

synchronous

pika.spec.has_content(methodNumber)