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

Class Link

source code

Known Subclasses:

A representation of an AMQP link, of which there are two concrete implementations, Sender and Receiver.

Instance Methods
 
__init__(self, impl) source code
 
open(self)
Opens the link.
source code
 
close(self)
Closes the link.
source code
 
state(self)
The state of the link as a bit field.
source code
 
source(self)
The source of the link as described by the local peer.
source code
 
target(self)
The target of the link as described by the local peer.
source code
 
remote_source(self)
The source of the link as described by the remote peer.
source code
 
remote_target(self)
The target of the link as described by the remote peer.
source code
 
session(self) source code
 
connection(self)
The connection on which this link was attached.
source code
 
delivery(self, tag) source code
 
current(self) source code
 
advance(self) source code
 
unsettled(self) source code
 
credit(self)
The amount of oustanding credit on this link.
source code
 
available(self) source code
 
queued(self) source code
 
next(self, mask) source code
 
name(self)
Returns the name of the link
source code
 
is_sender(self)
Returns true if this link is a sender.
source code
 
is_receiver(self)
Returns true if this link is a receiver.
source code
 
remote_snd_settle_mode(self) source code
 
remote_rcv_settle_mode(self) source code
 
drained(self) source code
 
remote_max_message_size(self) source code
 
detach(self) source code
 
free(self) source code

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

Inherited from Endpoint: remote_condition, transport

Static Methods
 
wrap(impl) source code
Class Variables
  SND_UNSETTLED = PN_SND_UNSETTLED
  SND_SETTLED = PN_SND_SETTLED
  SND_MIXED = PN_SND_MIXED
  RCV_FIRST = PN_RCV_FIRST
  RCV_SECOND = PN_RCV_SECOND
  snd_settle_mode = property(_get_snd_settle_mode, _set_snd_sett...
  rcv_settle_mode = property(_get_rcv_settle_mode, _set_rcv_sett...
  drain_mode = property(_get_drain, _set_drain)
  max_message_size = property(_get_max_message_size, _set_max_me...

Inherited from Endpoint: LOCAL_ACTIVE, LOCAL_CLOSED, LOCAL_UNINIT, REMOTE_ACTIVE, REMOTE_CLOSED, REMOTE_UNINIT, handler

Method Details

__init__(self, impl)
(Constructor)

source code 
Overrides: wrapper.Wrapper.__init__

open(self)

source code 

Opens the link.

In more detail, this moves the local state of the link to the ACTIVE state and triggers an attach frame to be sent to the peer. A link is fully active once both peers have attached it.

close(self)

source code 

Closes the link.

In more detail, this moves the local state of the link to the CLOSED state and triggers an detach frame (with the closed flag set) to be sent to the peer. A link is fully closed once both peers have detached it.

state(self)

source code 

The state of the link as a bit field. The state has a local and a remote component. Each of these can be in one of three states: UNINIT, ACTIVE or CLOSED. These can be tested by masking against LOCAL_UNINIT, LOCAL_ACTIVE, LOCAL_CLOSED, REMOTE_UNINIT, REMOTE_ACTIVE and REMOTE_CLOSED.

Decorators:
  • @property

source(self)

source code 

The source of the link as described by the local peer.

Decorators:
  • @property

target(self)

source code 

The target of the link as described by the local peer.

Decorators:
  • @property

remote_source(self)

source code 

The source of the link as described by the remote peer.

Decorators:
  • @property

remote_target(self)

source code 

The target of the link as described by the remote peer.

Decorators:
  • @property

session(self)

source code 
Decorators:
  • @property

connection(self)

source code 

The connection on which this link was attached.

Decorators:
  • @property

current(self)

source code 
Decorators:
  • @property

unsettled(self)

source code 
Decorators:
  • @property

credit(self)

source code 

The amount of oustanding credit on this link.

Decorators:
  • @property

available(self)

source code 
Decorators:
  • @property

queued(self)

source code 
Decorators:
  • @property

name(self)

source code 

Returns the name of the link

Decorators:
  • @property

is_sender(self)

source code 

Returns true if this link is a sender.

Decorators:
  • @property

is_receiver(self)

source code 

Returns true if this link is a receiver.

Decorators:
  • @property

remote_snd_settle_mode(self)

source code 
Decorators:
  • @property

remote_rcv_settle_mode(self)

source code 
Decorators:
  • @property

remote_max_message_size(self)

source code 
Decorators:
  • @property

Class Variable Details

snd_settle_mode

Value:
property(_get_snd_settle_mode, _set_snd_settle_mode)

rcv_settle_mode

Value:
property(_get_rcv_settle_mode, _set_rcv_settle_mode)

max_message_size

Value:
property(_get_max_message_size, _set_max_message_size)