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

Class Delivery

source code


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

Instance Methods
 
__init__(self, impl) source code
 
tag(self)
The identifier for the delivery.
source code
 
writable(self)
Returns true for an outgoing delivery to which data can now be written.
source code
 
readable(self)
Returns true for an incoming delivery that has data to read.
source code
 
updated(self)
Returns true if the state of the delivery has been updated (e.g.
source code
 
update(self, state)
Set the local state of the delivery e.g.
source code
 
pending(self) source code
 
partial(self)
Returns true for an incoming delivery if not all the data is yet available.
source code
 
local_state(self)
Returns the local state of the delivery.
source code
 
remote_state(self)
Returns the state of the delivery as indicated by the remote peer.
source code
 
settled(self)
Returns true if the delivery has been settled by the remote peer.
source code
 
settle(self)
Settles the delivery locally.
source code
 
aborted(self)
Returns true if the delivery has been aborted.
source code
 
abort(self)
Aborts the delivery.
source code
 
work_next(self) source code
 
link(self)
Returns the link on which the delivery was sent or received.
source code
 
session(self)
Returns the session over which the delivery was sent or received.
source code
 
connection(self)
Returns the connection over which the delivery was sent or received.
source code
 
transport(self) source code

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

Static Methods
 
wrap(impl) source code
Class Variables
  RECEIVED = DispositionType(PN_RECEIVED, "RECEIVED")
  ACCEPTED = DispositionType(PN_ACCEPTED, "ACCEPTED")
  REJECTED = DispositionType(PN_REJECTED, "REJECTED")
  RELEASED = DispositionType(PN_RELEASED, "RELEASED")
  MODIFIED = DispositionType(PN_MODIFIED, "MODIFIED")
Method Details

__init__(self, impl)
(Constructor)

source code 
Overrides: wrapper.Wrapper.__init__

tag(self)

source code 

The identifier for the delivery.

Decorators:
  • @property

writable(self)

source code 

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

Decorators:
  • @property

readable(self)

source code 

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

Decorators:
  • @property

updated(self)

source code 

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

Decorators:
  • @property

update(self, state)

source code 

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

pending(self)

source code 
Decorators:
  • @property

partial(self)

source code 

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

Decorators:
  • @property

local_state(self)

source code 

Returns the local state of the delivery.

Decorators:
  • @property

remote_state(self)

source code 

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

Decorators:
  • @property

settled(self)

source code 

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

Decorators:
  • @property

settle(self)

source code 

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

aborted(self)

source code 

Returns true if the delivery has been aborted.

Decorators:
  • @property

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.

work_next(self)

source code 
Decorators:
  • @property

link(self)

source code 

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

Decorators:
  • @property

session(self)

source code 

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

Decorators:
  • @property

connection(self)

source code 

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

Decorators:
  • @property

transport(self)

source code 
Decorators:
  • @property