Class Qpid::Proton::Link
In: lib/core/link.rb
Parent: Endpoint

The base for both Sender and Receiver, providing common functionality between both ends.

A Link has a single parent Qpid::Proton::Session instance.

Methods

Included Modules

Util::Wrapper

Constants

PROTON_METHOD_PREFIX = "pn_link"   @private
SND_UNSETTLED = Cproton::PN_SND_UNSETTLED   The sender will send all deliveries initially unsettled.
SND_SETTLED = Cproton::PN_SND_SETTLED   The sender will send all deliveries settled to the receiver.
SND_MIXED = Cproton::PN_SND_MIXED   The sender may send a mixture of settled and unsettled deliveries.
RCV_FIRST = Cproton::PN_RCV_FIRST   The receiver will settle deliveries regardless of what the sender does.
RCV_SECOND = Cproton::PN_RCV_SECOND   The receiver will only settle deliveries after the sender settles.

Public Class methods

@private

@private

Public Instance methods

Close the local end of the link. The remote end may or may not be closed. @param error [Condition] Optional error condition to send with the close.

Returns the parent connection.

@return [Connection] The connection.

Returns the current delivery.

Each link maintains a sequence of deliveries in the order they were created, along with a reference to the current delivery. All send and receive operations on a link take place on the current delivery. If a link has no current delivery, the current delivery is automatically pointed to the next delivery created on the link.

Once initialized, the current delivery remains the same until it is changed by advancing, or until it is settled.

@see next @see Delivery#settle

@return [Delivery] The current delivery.

@deprecated use {Sender#send}

Returns additional error information.

Whenever a link operation fails (i.e., returns an error code) additional error details can be obtained from this method. Ther error object that is returned may also be used to clear the error condition.

@return [Error] The error.

Returns the local receiver settle mode.

@return [Integer] The local receiver settle mode.

Sets the local receiver settle mode.

@param mode [Integer] The settle mode.

@see RCV_FIRST @see RCV_SECOND

Returns a representation of the remotely defined source terminus.

@return [Terminus] The terminus.

Returns a representation of the remotely defined target terminus.

@return [Terminus] The terminus.

Returns the parent session.

@return [Session] The session.

Returns the local sender settle mode.

@return [Integer] The local sender settle mode.

@see snd_settle_mode

Sets the local sender settle mode.

@param mode [Integer] The settle mode.

@see SND_UNSETTLED @see SND_SETTLED @see SND_MIXED

Returns the locally defined source terminus.

@return [Terminus] The terminus

Returns the locally defined target terminus.

@return [Terminus] The terminus.

[Validate]