Class Qpid::Proton::Terminus
In: lib/core/terminus.rb
Parent: Object

Represents an endpoint for an AMQP connection..

An AMQP terminus acts as either a source or a target for messages, but never as both. Every Link is associated iwth both a source and a target Terminus that is negotiated during link establishment.

A terminus is composed of an AMQP address along with a number of other properties defining the quality of service and behavior of the Link.

Methods

apply   capabilities   filter   inspect   new   outcomes   properties   replace   to_s  

Included Modules

Util::Deprecation Util::ErrorHandler

Constants

UNSPECIFIED = Cproton::PN_UNSPECIFIED   Indicates a non-existent source or target terminus.
SOURCE = Cproton::PN_SOURCE   Indicates a source for messages.
TARGET = Cproton::PN_TARGET   Indicates a target for messages.
COORDINATOR = Cproton::PN_COORDINATOR   A special target identifying a transaction coordinator.
EXPIRE_WITH_LINK = Cproton::PN_EXPIRE_WITH_LINK   The terminus is orphaned when the parent link is closed.
EXPIRE_WITH_SESSION = Cproton::PN_EXPIRE_WITH_SESSION   The terminus is orphaned whent he parent sessio is closed.
EXPIRE_WITH_CONNECTION = Cproton::PN_EXPIRE_WITH_CONNECTION   The terminus is orphaned when the parent connection is closed.
EXPIRE_NEVER = Cproton::PN_EXPIRE_NEVER   The terminus is never considered orphaned.
NONDURABLE = Cproton::PN_NONDURABLE   Indicates a non-durable Terminus.
CONFIGURATION = Cproton::PN_CONFIGURATION   Indicates a Terminus with durably held configuration, but not the delivery state.
DELIVERIES = Cproton::PN_DELIVERIES   Indicates a Terminus with both durably held configuration and durably held delivery states.
DIST_MODE_UNSPECIFIED = Cproton::PN_DIST_MODE_UNSPECIFIED   The behavior is defined by the nod.e
DIST_MODE_COPY = Cproton::PN_DIST_MODE_COPY   The receiver gets all messages.
DIST_MODE_MOVE = Cproton::PN_DIST_MODE_MOVE   The receives compete for messages.
PROTON_METHOD_PREFIX = "pn_terminus"   @private

Attributes

impl  [R]  @private

Public Class methods

@private

Public Instance methods

Apply options to this terminus. @option opts [String] :address the node address @option opts [Boolean] :dynamic (false)

  if true, request a new node with a unique address to be created. +:address+ is ignored.

@option opts [Integer] :distribution_mode see {distribution_mode}, only for source nodes @option opts [Integer] :durability_mode see {durability_mode} @option opts [Integer] :timeout see {timeout} @option opts [Integer] :expiry_policy see {expiry_policy} @option opts [Hash] :filter see {filter}, only for source nodes @option opts [Hash] :capabilities see {capabilities}

Access and modify the AMQP capabilities data for the Terminus.

This operation will return an instance of Data that is valid until the Terminus is freed due to its parent being freed. Any data contained in the object will be sent as the AMQP properties for the parent Terminus instance.

NOTE: this MUST take the form of a symbol keyed map to be valid.

@return [Data] The terminus capabilities.

Access and modify the AMQP filter set for a source terminus. Only relevant for a message source.

This operation will return an instance of Data that is valid until the Terminus is freed due to its parent being freed. Any data contained in the object will be sent as the AMQP properties for the parent Terminus instance.

NOTE: this MUST take the form of a symbol keyed map to be valid.

@return [Data] The terminus filter.

Access and modify the AMQP outcomes for the Terminus.

This operaiton will return an instance of Data that is valid until the Terminus is freed due to its parent being freed. Any data contained in the object will be sent as the AMQP properties for the parent Terminus instance.

NOTE: this MUST take the form of a symbol keyed map to be valid.

@return [Data] The terminus outcomes.

Access and modify the AMQP properties data for the Terminus.

This operation will return an instance of Data that is valid until the Terminus is freed due to its parent being freed. Any data contained in the object will be sent as the AMQP properties for the parent Terminus instance.

NOTE: this MUST take the form of a symbol keyed map to be valid.

@return [Data] The terminus properties.

Replace the data in this Terminus with the contents of other @param other [Terminus] The other instance.

[Validate]