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

type 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
 
delivery(self, tag) source code
 
advance(self) source code
 
next(self, mask) source code
 
drained(self) source code
 
detach(self) source code
 
free(self) source code

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

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

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

Properties
  state
The state of the link as a bit field.
  source
The source of the link as described by the local peer.
  target
The target of the link as described by the local peer.
  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
  connection
The connection on which this link was attached.
  transport
  current
  unsettled
  credit
The amount of outstanding credit on this link.
  available
  queued
  name
Returns the name of the link
  is_sender
Returns true if this link is a sender.
  is_receiver
Returns true if this link is a receiver.
  remote_snd_settle_mode
  remote_rcv_settle_mode
  snd_settle_mode
  rcv_settle_mode
  drain_mode
  remote_max_message_size
  max_message_size

Inherited from Endpoint: handler, remote_condition

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.


Property Details

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.

source

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

target

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

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

connection

The connection on which this link was attached.

transport

current

unsettled

credit

The amount of outstanding credit on this link.

available

queued

name

Returns the name of the link

is_sender

Returns true if this link is a sender.

is_receiver

Returns true if this link is a receiver.

remote_snd_settle_mode

remote_rcv_settle_mode

snd_settle_mode

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

rcv_settle_mode

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

drain_mode

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

remote_max_message_size

max_message_size

Get Method:
_get_max_message_size(self)
Set Method:
_set_max_message_size(self, mode)