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

Class Link

source code

     object --+    
              |    
wrapper.Wrapper --+
                  |
     object --+   |
              |   |
       Endpoint --+
                  |
                 Link
Known Subclasses:

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

Instance Methods
 
__init__(self, impl)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
advance(self) source code
 
close(self)
Closes the link.
source code
 
delivery(self, tag) source code
 
detach(self) source code
 
drained(self) source code
 
free(self) source code
 
next(self, mask) source code
 
open(self)
Opens the link.
source code

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

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

Static Methods
 
wrap(impl) source code
Class Variables
  RCV_FIRST = 0
  RCV_SECOND = 1
  SND_MIXED = 2
  SND_SETTLED = 1
  SND_UNSETTLED = 0

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

Properties
  available
  connection
The connection on which this link was attached.
  credit
The amount of oustanding credit on this link.
  current
  drain_mode
  is_receiver
Returns true if this link is a receiver.
  is_sender
Returns true if this link is a sender.
  name
Returns the name of the link
  queued
  rcv_settle_mode
  remote_rcv_settle_mode
  remote_snd_settle_mode
  remote_source
The source of the link as described by the remote peer.
  remote_target
The target of the link as described by the remote peer.
  session
  snd_settle_mode
  source
The source of the link as described by the local peer.
  state
The state of the link as a bit field.
  target
The target of the link as described by the local peer.
  unsettled

Inherited from Endpoint: handler, remote_condition, transport

Inherited from object: __class__

Method Details

__init__(self, impl)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

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.

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.


Property Details

available

Get Method:
unreachable.available(self)

connection

The connection on which this link was attached.

Get Method:
unreachable.connection(self) - The connection on which this link was attached.

credit

The amount of oustanding credit on this link.

Get Method:
unreachable.credit(self) - The amount of oustanding credit on this link.

current

Get Method:
unreachable.current(self)

drain_mode

Get Method:
_get_drain(self)
Set Method:
_set_drain(self, b)

is_receiver

Returns true if this link is a receiver.

Get Method:
unreachable.is_receiver(self) - Returns true if this link is a receiver.

is_sender

Returns true if this link is a sender.

Get Method:
unreachable.is_sender(self) - Returns true if this link is a sender.

name

Returns the name of the link

Get Method:
unreachable.name(self) - Returns the name of the link

queued

Get Method:
unreachable.queued(self)

rcv_settle_mode

Get Method:
_get_rcv_settle_mode(self)
Set Method:
_set_rcv_settle_mode(self, mode)

remote_rcv_settle_mode

Get Method:
unreachable.remote_rcv_settle_mode(self)

remote_snd_settle_mode

Get Method:
unreachable.remote_snd_settle_mode(self)

remote_source

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

Get Method:
unreachable.remote_source(self) - The source of the link as described by the remote peer.

remote_target

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

Get Method:
unreachable.remote_target(self) - The target of the link as described by the remote peer.

session

Get Method:
unreachable.session(self)

snd_settle_mode

Get Method:
_get_snd_settle_mode(self)
Set Method:
_set_snd_settle_mode(self, mode)

source

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

Get Method:
unreachable.source(self) - The source of the link as described by the local peer.

state

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.

Get Method:
unreachable.state(self) - The state of the link as a bit field.

target

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

Get Method:
unreachable.target(self) - The target of the link as described by the local peer.

unsettled

Get Method:
unreachable.unsettled(self)