Package proton :: Module _delivery :: Class Delivery
[frames] | no frames]

type Delivery

source code


Tracks and/or records the delivery of a message over a link.

Instance Methods
 
__init__(self, impl) source code
 
update(self, state)
Set the local state of the delivery e.g.
source code
 
settle(self)
Settles the delivery locally.
source code
 
abort(self)
Aborts the delivery.
source code

Inherited from _wrapper.Wrapper: __del__, __delattr__, __eq__, __getattr__, __hash__, __ne__, __repr__, __setattr__

Static Methods
 
wrap(impl) source code
Class Variables
  RECEIVED = RECEIVED
  ACCEPTED = ACCEPTED
  REJECTED = REJECTED
  RELEASED = RELEASED
  MODIFIED = MODIFIED
Properties
  tag
The identifier for the delivery.
  writable
Returns true for an outgoing delivery to which data can now be written.
  readable
Returns true for an incoming delivery that has data to read.
  updated
Returns true if the state of the delivery has been updated (e.g.
  pending
  partial
Returns true for an incoming delivery if not all the data is yet available.
  local_state
Returns the local state of the delivery.
  remote_state
Returns the state of the delivery as indicated by the remote peer.
  settled
Returns true if the delivery has been settled by the remote peer.
  aborted
Returns true if the delivery has been aborted.
  work_next
  link
Returns the link on which the delivery was sent or received.
  session
Returns the session over which the delivery was sent or received.
  connection
Returns the connection over which the delivery was sent or received.
  transport
Method Details

__init__(self, impl)
(Constructor)

source code 
Overrides: _wrapper.Wrapper.__init__

update(self, state)

source code 

Set the local state of the delivery e.g. ACCEPTED, REJECTED, RELEASED.

settle(self)

source code 

Settles the delivery locally. This indicates the application considers the delivery complete and does not wish to receive any further events about it. Every delivery should be settled locally.

abort(self)

source code 

Aborts the delivery. This indicates the application wishes to invalidate any data that may have already been sent on this delivery. The delivery cannot be aborted after it has been completely delivered.


Property Details

tag

The identifier for the delivery.

writable

Returns true for an outgoing delivery to which data can now be written.

readable

Returns true for an incoming delivery that has data to read.

updated

Returns true if the state of the delivery has been updated (e.g. it has been settled and/or accepted, rejected etc).

pending

partial

Returns true for an incoming delivery if not all the data is yet available.

local_state

Returns the local state of the delivery.

remote_state

Returns the state of the delivery as indicated by the remote peer.

settled

Returns true if the delivery has been settled by the remote peer.

aborted

Returns true if the delivery has been aborted.

work_next

link

Returns the link on which the delivery was sent or received.

session

Returns the session over which the delivery was sent or received.

connection

Returns the connection over which the delivery was sent or received.

transport