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

Class MessageFlow

object --+        
         |        
  Compound --+    
             |    
       Command --+
                 |
                MessageFlow

This command controls the flow of message data to a given destination.
It is used by the recipient of messages to dynamically match the
incoming rate of message flow to its processing or forwarding
capacity. Upon receipt of this command, the sender must add "value"
number of the specified unit to the available credit balance for the
specified destination. A value of (0xFFFFFFFF) indicates an infinite
amount of credit. This disables any limit for the given unit until the
credit balance is zeroed with message.stop or message.flush.

  destination -- None

  unit -- None

    The unit of value.

  value -- None

    If the value is not set then this indicates an infinite amount of
    credit.

Instance Methods

Inherited from Compound: __getitem__, __init__, __repr__, __setitem__, args, dispatch, fields

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
  ARGS = [destination: str8, unit: uint8, value: uint32, channel...
  CODE = 1034
  FIELDS = [destination: str8, unit: uint8, value: uint32]
  NAME = 'message_flow'
  PACK = 2
  RESULT = None
  SIZE = 0

Inherited from Command: UNENCODED

Properties

Inherited from object: __class__

Class Variable Details

ARGS

Value:
[destination: str8,
 unit: uint8,
 value: uint32,
 channel: uint16,
 id: sequence-no,
 sync: bit,
 headers: None,
 payload: None]