Class: Qpid::Proton::Terminus

Inherits:
Object
  • Object
show all
Defined in:
lib/core/terminus.rb

Overview

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.

Constant Summary

UNSPECIFIED =

Indicates a non-existent source or target terminus.

Cproton::PN_UNSPECIFIED
SOURCE =

Indicates a source for messages.

Cproton::PN_SOURCE
TARGET =

Indicates a target for messages.

Cproton::PN_TARGET
COORDINATOR =

A special target identifying a transaction coordinator.

Cproton::PN_COORDINATOR
Cproton::PN_EXPIRE_WITH_LINK
EXPIRE_WITH_SESSION =

The terminus is orphaned whent he parent sessio is closed.

Cproton::PN_EXPIRE_WITH_SESSION
EXPIRE_WITH_CONNECTION =

The terminus is orphaned when the parent connection is closed.

Cproton::PN_EXPIRE_WITH_CONNECTION
EXPIRE_NEVER =

The terminus is never considered orphaned.

Cproton::PN_EXPIRE_NEVER
NONDURABLE =

Indicates a non-durable Terminus.

Cproton::PN_NONDURABLE
CONFIGURATION =

Indicates a Terminus with durably held configuration, but not the delivery state.

Cproton::PN_CONFIGURATION
DELIVERIES =

Indicates a Terminus with both durably held configuration and durably held delivery states.

Cproton::PN_DELIVERIES
DIST_MODE_UNSPECIFIED =

The behavior is defined by the nod.e

Cproton::PN_DIST_MODE_UNSPECIFIED
DIST_MODE_COPY =

The receiver gets all messages.

Cproton::PN_DIST_MODE_COPY
DIST_MODE_MOVE =

The receives compete for messages.

Cproton::PN_DIST_MODE_MOVE

Instance Method Summary collapse

Instance Method Details

#apply(opts = nil)

Apply options to this terminus.

Parameters:

  • opts (Hash) (defaults to: nil)

    a customizable set of options

Options Hash (opts):

  • :address (String)

    the node address

  • :dynamic (Boolean) — default: false

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

  • :distribution_mode (Integer)

    see #distribution_mode, only for source nodes

  • :durability_mode (Integer)

    see #durability_mode

  • :timeout (Integer)

    see #timeout

  • :expiry_policy (Integer)

    see #expiry_policy

  • :filter (Hash)

    see #filter, only for source nodes

  • :capabilities (Hash)


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/core/terminus.rb', line 226

def apply(opts=nil)
  return unless opts
  if opts.is_a? String      # Shorthand for address
    self.address = opts
  else
    opts.each_pair do |k,v|
      case k
      when :address then self.address = v
      when :dynamic then self.dynamic = !!v
      when :distribution_mode then self.distribution_mode = v
      when :durability_mode then self.durability_mode = v
      when :timeout then self.timeout = v.round # Should be integer seconds
      when :expiry_policy then self.expiry_policy = v
      when :filter then self.filter << v
      when :capabilities then self.capabilities << v
      end
    end
  end
end

#capabilitiesData

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.

Returns:

  • (Data)

    The terminus capabilities.



173
174
175
# File 'lib/core/terminus.rb', line 173

def capabilities
  Codec::Data.new(Cproton.pn_terminus_capabilities(@impl))
end

#filterData

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.

Returns:

  • (Data)

    The terminus filter.



204
205
206
# File 'lib/core/terminus.rb', line 204

def filter
  Codec::Data.new(Cproton.pn_terminus_filter(@impl))
end

#inspect



246
247
248
# File 'lib/core/terminus.rb', line 246

def inspect()
  "\#<#{self.class}: address=#{address.inspect} dynamic?=#{dynamic?.inspect}>"
end

#outcomesData

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.

Returns:

  • (Data)

    The terminus outcomes.



188
189
190
# File 'lib/core/terminus.rb', line 188

def outcomes
  Codec::Data.new(Cproton.pn_terminus_outcomes(@impl))
end

#propertiesData

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.

Returns:

  • (Data)

    The terminus properties.



158
159
160
# File 'lib/core/terminus.rb', line 158

def properties
  Codec::Data.new(Cproton.pn_terminus_properties(@impl))
end

#replace(other)

Replace the data in this Terminus with the contents of other

Parameters:

  • other (Terminus)

    The other instance.



210
211
212
213
# File 'lib/core/terminus.rb', line 210

def replace(other)
  Cproton.pn_terminus_copy(@impl, other.impl)
  self
end

#to_s



250
# File 'lib/core/terminus.rb', line 250

def to_s() inspect; end