Package qpid :: Module ops
[frames] | no frames]

Module ops

Classes
  Primitive
  Enum
  Field
  Compound
  Command
  Control
  Acquired
Identifies a set of previously transferred messages that have now been acquired.
  Array
An array is an ordered sequence of values of the same type.
  Bin1024
The bin1024 type consists of one hundred and twenty eight octets of opaque binary data.
  Bin128
The bin128 type consists of 16 consecutive octets of opaque binary data.
  Bin16
The bin16 type consists of two consecutive octets of opaque binary data.
  Bin256
The bin256 type consists of thirty two consecutive octets of opaque binary data.
  Bin32
The bin32 type consists of 4 consecutive octets of opaque binary data.
  Bin40
The bin40 type consists of five consecutive octets of opaque binary data.
  Bin512
The bin512 type consists of sixty four consecutive octets of opaque binary data.
  Bin64
The bin64 type consists of eight consecutive octets of opaque binary data.
  Bin72
The bin72 type consists of nine consecutive octets of opaque binary data.
  Bin8
The bin8 type consists of exactly one octet of opaque binary data.
  Bit
The bit type is used to indicate that a packing flag within a packed struct is being used to represent a boolean value based on the presence of an empty value.
  Boolean
The boolean type is a single octet that encodes a true or false value.
  ByteRanges
The byte-ranges type encodes up to 65535 octets worth of non- overlapping, non-touching, ascending byte ranges within a 64-bit sequence of bytes.
  Char
The char type encodes a single character from the iso-8859-15 character set.
  CharUtf32
The char-utf32 type consists of a single unicode character in the UTF-32 encoding.
  CommandFragment
command_id -- None
  ConnectionClose
This control indicates that the sender wants to close the connection.
  ConnectionCloseOk
This control confirms a connection.close control and tells the recipient that it is safe to release resources for the connection and close the socket.
  ConnectionHeartbeat
The heartbeat control may be used to generate artificial network traffic when a connection is idle.
  ConnectionOpen
This control opens a connection to a virtual host, which is a collection of resources, and acts to separate multiple application domains within a server.
  ConnectionOpenOk
This control signals to the client that the connection is ready for use.
  ConnectionRedirect
This control redirects the client to another server, based on the requested virtual host and/or capabilities.
  ConnectionSecure
The SASL protocol works by exchanging challenges and responses until both peers have received sufficient information to authenticate each other.
  ConnectionSecureOk
This control attempts to authenticate, passing a block of SASL data for the security mechanism at the server side.
  ConnectionStart
This control starts the connection negotiation process by telling the client the supported security mechanisms and locales from which the client can choose.
  ConnectionStartOk
This control selects a SASL security mechanism.
  ConnectionTune
This control proposes a set of connection configuration values to the client.
  ConnectionTuneOk
This control sends the client's connection tuning parameters to the server.
  Datetime
The datetime type encodes a date and time using the 64 bit POSIX time_t format.
  Dec32
The dec32 type is decimal value with a variable number of digits following the decimal point.
  Dec64
The dec64 type is decimal value with a variable number of digits following the decimal point.
  DeliveryProperties
discard_unroutable -- controls discard of unroutable messages
  Double
The double type encodes a double precision 64-bit floating point number.
  DtxCommit
Commit the work done on behalf a transaction branch.
  DtxEnd
This command is called when the work done on behalf a transaction branch finishes or needs to be suspended.
  DtxForget
This command is called to forget about a heuristically completed transaction branch.
  DtxGetTimeout
This command obtains the current transaction timeout value in seconds.
  DtxPrepare
This command prepares for commitment any message produced or consumed on behalf of xid.
  DtxRecover
This command is called to obtain a list of transaction branches that are in a prepared or heuristically completed state.
  DtxRollback
This command rolls back the work associated with xid.
  DtxSelect
This command sets the session to use distributed transactions.
  DtxSetTimeout
Sets the specified transaction branch timeout value in seconds.
  DtxStart
This command is called when messages should be produced and consumed on behalf a transaction branch identified by xid.
  ExchangeBind
This command binds a queue to an exchange.
  ExchangeBound
This command is used to request information on the bindings to a particular exchange.
  ExchangeBoundResult
exchange_not_found -- indicate an unknown exchange
  ExchangeDeclare
This command creates an exchange if it does not already exist, and if the exchange exists, verifies that it is of the correct and expected class.
  ExchangeDelete
This command deletes an exchange.
  ExchangeQuery
This command is used to request information on a particular exchange.
  ExchangeQueryResult
This is sent in response to a query request and conveys information on a particular exchange.
  ExchangeUnbind
This command unbinds a queue from an exchange.
  ExecutionException
This command informs a peer of an execution exception.
  ExecutionResult
This command carries data resulting from the execution of a command.
  ExecutionSync
This command is complete when all prior commands are completed.
  Float
The float type encodes a single precision 32-bit floating point number.
  FragmentProperties
These properties permit the transfer of message fragments.
  GetTimeoutResult
Returns the value of the timeout last specified through set-timeout.
  Header
The session header appears on commands after the class and command id, but prior to command arguments.
  Int16
The int16 type is a signed integral value encoded using a 16-bit two's complement representation in network byte order.
  Int32
The int32 type is a signed integral value encoded using a 32-bit two's complement representation in network byte order.
  Int64
The int64 type is a signed integral value encoded using a 64-bit two's complement representation in network byte order.
  Int8
The int8 type is a signed integral value encoded using an 8-bit two's complement representation.
  List
A list is an ordered sequence of (type, value) pairs.
  Map
A map is a set of distinct keys where each key has an associated (type,value) pair.
  MessageAccept
Accepts the message.
  MessageAcquire
Acquires previously transferred messages for consumption.
  MessageCancel
This command cancels a subscription.
  MessageFlow
This command controls the flow of message data to a given destination.
  MessageFlush
Forces the sender to exhaust his credit supply.
  MessageProperties
content_length -- length of the body segment in bytes
  MessageReject
Indicates that the message transfers are unprocessable in some way.
  MessageRelease
Release previously transferred messages.
  MessageResume
This command resumes an interrupted transfer.
  MessageResumeResult
offset -- None
  MessageSetFlowMode
Sets the mode of flow control used for a given destination to either window or credit based flow control.
  MessageStop
On receipt of this command, a producer of messages MUST set his credit to zero for the given destination.
  MessageSubscribe
This command asks the server to start a "subscription", which is a request for messages from a specific queue.
  MessageTransfer
This command transfers a message between two peers.
  QueueDeclare
This command creates or checks a queue.
  QueueDelete
This command deletes a queue.
  QueuePurge
This command removes all messages from a queue.
  QueueQuery
This command requests information about a queue.
  QueueQueryResult
This is sent in response to queue.query, and conveys the requested information about a queue.
  RecoverResult
Returns to the client a table with single item that is a sequence of transaction xids that are in a prepared or heuristically completed state.
  ReplyTo
The reply-to domain provides a simple address structure for replying to to a message to a destination within the same virtual-host.
  SequenceNo
The sequence-no type encodes, in network byte order, a serial number as defined in RFC-1982.
  SequenceSet
The sequence-set type is a set of pairs of RFC-1982 numbers representing a discontinuous range within an RFC-1982 sequence.
  SessionAttach
Requests that the current transport be attached to the named session.
  SessionAttached
Confirms successful attachment of the transport to the named session.
  SessionCommandPoint
This control is sent by the sender of commands and handled by the receiver of commands.
  SessionCompleted
This control is sent by the receiver of commands, and handled by the sender of commands.
  SessionConfirmed
This control is sent by the receiver of commands and handled by the sender of commands.
  SessionDetach
Detaches the current transport from the named session.
  SessionDetached
Confirms detachment of the current transport from the named session.
  SessionExpected
This control is sent by the receiver of commands and handled by the sender of commands.
  SessionFlush
This control is sent by the sender of commands and handled by the receiver of commands.
  SessionGap
This control is sent by the sender of commands and handled by the receiver of commands.
  SessionKnownCompleted
This control is sent by the sender of commands, and handled by the receiver of commands.
  SessionRequestTimeout
This control may be sent by either the sender or receiver of commands.
  SessionTimeout
This control may be sent by the either the sender or receiver of commands.
  Str16
The str16 type encodes up to 65535 octets worth of UTF-8 unicode.
  Str16Latin
The str16-latin type encodes up to 65535 octets of is-8859-15 characters.
  Str16Utf16
The str16-utf16 type encodes up to 65535 octets worth of UTF-16 unicode.
  Str8
The str8 type encodes up to 255 octets worth of UTF-8 unicode.
  Str8Latin
The str8-latin type encodes up to 255 octets of iso-8859-15 characters.
  Str8Utf16
The str8-utf16 type encodes up to 255 octets worth of UTF-16 unicode.
  Struct32
The struct32 type describes any coded struct with a 32-bit (4 octet) size.
  TxCommit
This command commits all messages published and accepted in the current transaction.
  TxRollback
This command abandons the current transaction.
  TxSelect
This command sets the session to use standard transactions.
  Uint16
The uint16 type is a 16-bit unsigned integral value encoded in network byte order.
  Uint32
The uint32 type is a 32-bit unsigned integral value encoded in network byte order.
  Uint64
The uint64 type is a 64-bit unsigned integral value encoded in network byte order.
  Uint8
The uint8 type is an 8-bit unsigned integral value.
  Uuid
The uuid type encodes a universally unique id as defined by RFC-4122.
  Vbin16
The vbin16 type encodes up to 65535 octets of opaque binary data.
  Vbin32
The vbin32 type encodes up to 4294967295 octets of opaque binary data.
  Vbin8
The vbin8 type encodes up to 255 octets of opaque binary data.
  Void
The void type is used within tagged data structures such as maps and lists to indicate an empty value.
  XaResult
status -- None
  Xid
An xid uniquely identifies a transaction branch.
  accept_mode
explicit -- None
  acquire_mode
pre_acquired -- None
  close_code
normal -- None
  credit_unit
message -- None
  delivery_mode
non_persistent -- None
  delivery_priority
lowest -- None
  detach_code
normal -- None
  error_code
unauthorized_access -- None
  flow_mode
credit -- None
  reject_code
unspecified -- None
  segment_type
control -- None
  t
The bit type is used to indicate that a packing flag within a packed struct is being used to represent a boolean value based on the presence of an empty value.
  track
control -- None
  xa_status
xa_ok -- None
Functions
 
pythonize(st)
 
pydoc(op, children=())
 
studly(st)
 
klass(nd)
 
included(nd)
 
num(s)
 
code(nd)
 
default(f)
 
make_compound(decl, base, domains)
 
make_restricted(decl, domains)
 
make_type(decl, domains)
 
make_command(decl, domains)
 
make_control(decl, domains)
 
make_struct(decl, domains)
 
make_enum(decl, domains)
 
make(nd, domains)
 
qualify(nd, field='@name')
 
resolve(nd, domains)
 
load_types_from_xml(file)
 
load_types(file)
Variables
  vars = {'Acquired': <class 'qpid.ops.Acquired'>, 'Array': <cla...
  types = [('ExecutionSync', (<class 'qpid.ops.Command'>), {'ARG...
  ENUMS = {'accept_mode': <class 'qpid.ops.accept_mode'>, 'acqui...
  PRIMITIVE = {None: <class 'qpid.ops.SequenceSet'>, 0: <class '...
  COMPOUND = {1025: <class 'qpid.ops.DeliveryProperties'>, 1026:...
  COMMANDS = {769: <class 'qpid.ops.ExecutionSync'>, 770: <class...
  CONTROLS = {257: <class 'qpid.ops.ConnectionStart'>, 258: <cla...
  __package__ = 'qpid'
  bases = (<class 'qpid.ops.Primitive'>)
  name = 'Bit'
Variables Details

vars

Value:
{'Acquired': <class 'qpid.ops.Acquired'>,
 'Array': <class 'qpid.ops.Array'>,
 'Bin1024': <class 'qpid.ops.Bin1024'>,
 'Bin128': <class 'qpid.ops.Bin128'>,
 'Bin16': <class 'qpid.ops.Bin16'>,
 'Bin256': <class 'qpid.ops.Bin256'>,
 'Bin32': <class 'qpid.ops.Bin32'>,
 'Bin40': <class 'qpid.ops.Bin40'>,
...

types

Value:
[('ExecutionSync',
  (<class 'qpid.ops.Command'>),
  {'ARGS': [channel: uint16,
            id: sequence-no,
            sync: bit,
            headers: None,
            payload: None],
   'CODE': 769,
...

ENUMS

Value:
{'accept_mode': <class 'qpid.ops.accept_mode'>,
 'acquire_mode': <class 'qpid.ops.acquire_mode'>,
 'close_code': <class 'qpid.ops.close_code'>,
 'credit_unit': <class 'qpid.ops.credit_unit'>,
 'delivery_mode': <class 'qpid.ops.delivery_mode'>,
 'delivery_priority': <class 'qpid.ops.delivery_priority'>,
 'detach_code': <class 'qpid.ops.detach_code'>,
 'error_code': <class 'qpid.ops.error_code'>,
...

PRIMITIVE

Value:
{None: <class 'qpid.ops.SequenceSet'>,
 0: <class 'qpid.ops.Bin8'>,
 1: <class 'qpid.ops.Int8'>,
 2: <class 'qpid.ops.Uint8'>,
 4: <class 'qpid.ops.Char'>,
 8: <class 'qpid.ops.Boolean'>,
 16: <class 'qpid.ops.Bin16'>,
 17: <class 'qpid.ops.Int16'>,
...

COMPOUND

Value:
{1025: <class 'qpid.ops.DeliveryProperties'>,
 1026: <class 'qpid.ops.FragmentProperties'>,
 1027: <class 'qpid.ops.MessageProperties'>,
 1028: <class 'qpid.ops.Acquired'>,
 1029: <class 'qpid.ops.MessageResumeResult'>,
 1537: <class 'qpid.ops.XaResult'>,
 1538: <class 'qpid.ops.GetTimeoutResult'>,
 1539: <class 'qpid.ops.RecoverResult'>,
...

COMMANDS

Value:
{769: <class 'qpid.ops.ExecutionSync'>,
 770: <class 'qpid.ops.ExecutionResult'>,
 771: <class 'qpid.ops.ExecutionException'>,
 1025: <class 'qpid.ops.MessageTransfer'>,
 1026: <class 'qpid.ops.MessageAccept'>,
 1027: <class 'qpid.ops.MessageReject'>,
 1028: <class 'qpid.ops.MessageRelease'>,
 1029: <class 'qpid.ops.MessageAcquire'>,
...

CONTROLS

Value:
{257: <class 'qpid.ops.ConnectionStart'>,
 258: <class 'qpid.ops.ConnectionStartOk'>,
 259: <class 'qpid.ops.ConnectionSecure'>,
 260: <class 'qpid.ops.ConnectionSecureOk'>,
 261: <class 'qpid.ops.ConnectionTune'>,
 262: <class 'qpid.ops.ConnectionTuneOk'>,
 263: <class 'qpid.ops.ConnectionOpen'>,
 264: <class 'qpid.ops.ConnectionOpenOk'>,
...