class Qpid::Messaging::Message

A Message represents an routable piece of information.

Public Class Methods

new(args = {}) click to toggle source

Creates a Message.

Options

  • :content - the content

Examples

# create a simple message and sends it
message = Qpid::Messaging::Message.new :content => "This is a message."
sender.send message
# File qpid/ruby/lib/qpid_messaging/message.rb, line 39
def initialize(args = {})
  @message_impl = (args[:impl] if args[:impl]) || nil
  @message_impl = Cqpid::Message.new if @message_impl.nil?
  @content = nil
  args = {} if args.nil?
  self.content = args[:content] if args[:content]
end

Public Instance Methods

[](key) click to toggle source

Returns the value for the named property.

Options

  • name - the property name

Examples

# use of message properties to mark a message as digitally signed
verify(msg) if msg[:signed]
# File qpid/ruby/lib/qpid_messaging/message.rb, line 263
def [](key); self.properties[key.to_s]; end
[]=(key, value) click to toggle source

Assigns a value to the named property.

A property’s name or value, if a symbol, will be converted to a string representation. However, you will still be able to access them using a symbol for the name.

Options

  • name - the property name

  • value - the property value

Examples

# set the signed attribute on a message and then retrieve it
msg[:signed] = true # sets "signed" => true
puts "It's signed" if msg["signed"] # outputs "It's signed"
# File qpid/ruby/lib/qpid_messaging/message.rb, line 282
def []=(key, value)
  @message_impl.setProperty(key.to_s,
                            Qpid::Messaging.stringify(value))
end
content() click to toggle source

Returns the content of the Message.

Content is automatically decoded based on the specified content type. If the content type is application-specific, then no decoding is performed and the content is returnedas a String representation.

For example, if an array of integers are sent, then the receiver will find the message content to be an array of String objects, where each String is a representation of the sent integer value.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 330
def content
  if @content.nil?
    @content = @message_impl.getContent

    # decode the content is necessary if it
    # has an encoded content type
    if ["amqp/list", "amqp/map"].include? @message_impl.getContentType
      @content = Qpid::Messaging.decode(self,
                                        @message_impl.getContentType)
    end

  end
  @content
end
content=(content) click to toggle source

Sets the content for the Message.

Content is automatically encoded for Array and Hash types. Other types need to set their own content types (via #content_type) in order to specify how recipients should process the content.

Options

  • content - the content

Examples

# set a simple content for a message
msg.content = "This is a simple message."
# sets content that is automatically encoded
msg.content = {:foo => :bar}
# File qpid/ruby/lib/qpid_messaging/message.rb, line 304
def content=(content)
  content_type = nil
  @content = Qpid::Messaging.stringify(content)
  case @content
  when Hash
    content_type = "amqp/map"
  when Array
    content_type = "amqp/list"
  end
  if content_type.nil?
    @message_impl.setContent @content
  else
    Qpid::Messaging.encode @content, self, content_type
  end
end
content_size() click to toggle source

Returns the content’s size in bytes.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 346
def content_size; @message_impl.getContentSize; end
content_type() click to toggle source

Returns the content type for the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 112
def content_type; @message_impl.getContentType; end
content_type=(content_type) click to toggle source

Sets the content type for the Message.

This should be set by the sending application and indicates to the recipients of the message how to interpret or decode the content.

By default, only dictionaries and maps are automatically given a content type. If this content type is replaced then retrieving the content will not behave correctly.

Options

  • content_type - the content type

Examples

# send base64 encoded data in a mesage
msg = Qpid::Messaging::Message.new :content = "UXBpZCBSdWxlcyEK"
msg.content_type = "application/base64"
# File qpid/ruby/lib/qpid_messaging/message.rb, line 109
def content_type=(content_type); @message_impl.setContentType content_type; end
correlation_id() click to toggle source

Returns the correlation id of the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 172
def correlation_id; @message_impl.getCorrelationId; end
correlation_id=(correlation_id) click to toggle source

Sets the correlation id of the Message.

The correlation id can be used as part of a protocol for message exchange patterns; e.g., a request-response pattern might require the correlation id of the request and the response to match, or it might use the message id of the request as the correlation id on the response.

NOTE: If the id is not a String then the id is setup using the object's string representation.

Options

  • id - the id

# File qpid/ruby/lib/qpid_messaging/message.rb, line 169
def correlation_id=(correlation_id); @message_impl.setCorrelationId correlation_id; end
durable() click to toggle source

Returns the durability for the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 225
def durable; @message_impl.getDurable; end
durable=(durable) click to toggle source

Sets the durability of the Message.

This is a hint to the messaging infrastructure that the message should be persisted or otherwise stored. This helps to ensure that the message is not lost due to failures or a shutdown.

Options

  • durable - the durability flag (def. false)

# File qpid/ruby/lib/qpid_messaging/message.rb, line 222
def durable=(durable); @message_impl.setDurable durable; end
message_id() click to toggle source

Returns the message id.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 132
def message_id; @message_impl.getMessageId; end
message_id=(message_id) click to toggle source

Sets the message id.

NOTE: this field must be a UUID type currently. A non-UUID value will be converted to a zero UUID, though a blank ID will be left untouched.

Options

  • id - the id

Examples

# this example only works in Ruby >= 1.9, for 1.8 use a UUID library
require 'SecureRandom'
msg.message_id = SecureRandom.uuid
# File qpid/ruby/lib/qpid_messaging/message.rb, line 129
def message_id=(message_id); @message_impl.setMessageId message_id.to_s; end
priority() click to toggle source

Returns the priority for the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 190
def priority; @message_impl.getPriority; end
priority=(priority) click to toggle source

Sets the priority of the Message.

This may be used by the messaging infrastructure to prioritize delivery of messages with higher priority.

NOTE: If the priority is not an integer type then it is set using the object's integer representation. If the integer value is greater than 8-bits then only the first 8-bits are used.

Options

  • priority - the priority

# File qpid/ruby/lib/qpid_messaging/message.rb, line 187
def priority=(priority); @message_impl.setPriority priority; end
properties() click to toggle source

Returns all named properties.

NOTE: It is recommended to use the []= method for retrieving and setting properties. Using this method may result in non-deterministic behavior.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 250
def properties; @message_impl.getProperties; end
redelivered() click to toggle source

Returns whether the Message has been marked as redelivered.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 243
def redelivered; @message_impl.getRedelivered; end
redelivered=(redelivered) click to toggle source

This is a hint to the messaging infrastructure that if de-duplication is required, that this message should be examined to determine if it is a duplicate.

Options

  • redelivered - sets the redelivered state (def. false)

Examples

# processed is a collection of messages already received
msg.redelivered = true if processed.include? msg.message_id
# File qpid/ruby/lib/qpid_messaging/message.rb, line 240
def redelivered=(redelivered); @message_impl.setRedelivered redelivered; end
reply_to() click to toggle source

Returns the reply to address for the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 74
def reply_to
  address_impl = @message_impl.getReplyTo
  # only return an address if a reply to was specified
  Qpid::Messaging::Address.new(nil, address_impl) if address_impl
end
reply_to=(address) click to toggle source

Sets the reply-to address.

The address can either be an instance of Address or else and address string.

Options

  • address - the address

Examples

# set replies using an Address
msg.reply_to = Qpid:Messaging::Address.new "my-responses"
# set replies using an address string
msg.reply_to = "my-feed/responses"
# File qpid/ruby/lib/qpid_messaging/message.rb, line 67
def reply_to=(address)
  address = Qpid::Messaging::Address.new "#{address}" if !address.is_a? Qpid::Messaging::Address

  @message_impl.setReplyTo address.address_impl
end
subject() click to toggle source

Returns the subject of the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 88
def subject; @message_impl.getSubject; end
subject=(subject) click to toggle source

Sets the subject for the Message.

Options

  • subject - the subject

# File qpid/ruby/lib/qpid_messaging/message.rb, line 85
def subject=(subject); @message_impl.setSubject subject; end
ttl() click to toggle source

Returns the time-to-live in milliseconds.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 210
def ttl; Qpid::Messaging::Duration.new @message_impl.getTtl.getMilliseconds; end
ttl=(duration) click to toggle source

Sets the time-to-live in milliseconds.

This can be used by the messaging infrastructure to discard messages that are no longer of relevance.

Options

  • duration - the number of milliseconds

# File qpid/ruby/lib/qpid_messaging/message.rb, line 201
def ttl=(duration)
  if duration.is_a? Qpid::Messaging::Duration
    @message_impl.setTtl duration.duration_impl
  else
    @message_impl.setTtl Cqpid::Duration.new duration.to_i
  end
end
user_id() click to toggle source

Returns the user id for the Message.

# File qpid/ruby/lib/qpid_messaging/message.rb, line 152
def user_id; @message_impl.getUserId; end
user_id=(user_id) click to toggle source

Sets the user id for the Message.

This should in general be the user-id which was used when authenticating the connection itself, as the messaging infrastructure will verify this.

See Qpid::Messaging::Connection#authenticated_username

NOTE: If the id is not a String then the id is set using the object's string representation.

Options

  • id - the id

# File qpid/ruby/lib/qpid_messaging/message.rb, line 149
def user_id=(user_id); @message_impl.setUserId user_id; end