Class Qpid::Messaging::Address
In: lib/qpid/address.rb
Parent: Object

Address represents an address to which messages can be sent or from which they can be received.

An Address can be described using the following pattern:

<address> [ / <subject> ] ; [ { <key> : <value> , … } ]

where address is a simple name and subject is a subject or subject pattern.

The options, enclosed in curly braces, are key:value pairs delimited by a comma. The values can be nested maps also enclosed in curly braces. Or they can be lists of values, where they are contained within square brackets but still comma delimited, such as:

  [value1,value2,value3]

The following are the list of supported options:

:create
Indicates if the address should be created; values are always, never, sender or reciever.
:assert
Indicates whether or not to assert any specified node properties; values are always, never, sender or receiver.
:delete
Indicates whether or not to delete the addressed node when a sender or receiver is cancelled; values are always, never, sender or receiver.
:node
A nested map describing properties for the addressed node. Properties are type (topic or queue), durable (a boolean), *x-declare* (a nested map of amqp 0.10-specific options) and *x-bindings*. (nested list which specifies a queue, exchange or a binding key and arguments.
:link
A nested map through which properties of the link can be specified; properties are durable, reliability, *x-declare*, *x-subscribe* and *x-bindings*.
:mode
(*For receivers only*) indicates whether the receiver should consume or browse messages; values are consume (the default) and browse.

Methods

address_type   address_type=   name   name=   new   options   options=   subject   subject=  

Public Class methods

Creates a new Address object.

Options

  • name - The name for the Address.
  • subject - The subject for the Address
  • :create - See the class documentation.
  • :assert - See the class documentation.
  • :delete - See the class documentation.
  • :node - See the class documentation.
  • :link - See the class documentation.
  • :mode - See the class documentation.

Examples

  addr = Qpid::Messaging::Address.new "my-queue"
  addr = Qpid::Messaging::Address.new "my-queue", "testing", :create => :always

Public Instance methods

Returns the type for the Address.

Examples

  puts "The address is a #{address.address_type}."

Sets the type for the Address.

The type of the address determines how Sender and Receiver objects are constructed for it. If no type is specified then it will be determined by querying the broker.

Options
  • type - the address type

Returns the name for the Address.

Examples

  puts "The address name is #{addr.name}."

Sets the name for the Address.

Examples

  addr.name = "my-new-queue"

Returns the options.

Sets the options for the address.

*NOTE:* See the class documentation for more details on options.

Examples

  addr.options = :create => :always

Returns the subject for the Address.

Examples

  puts "The subject is #{addr.subject}."

Sets the subject for the Address.

Examples

  addr.subject = "testing"

[Validate]