Class: Qpid::Messaging::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/qpid_messaging/message.rb

Overview

A Message represents an routable piece of information.

The content for a message is automatically encoded and decoded.

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Message

Creates a new instance of Message.

Options

  • :content - The content.

Examples

message = Qpid::Messaging::Message.new :content => "This is a message."



40
41
42
43
44
45
46
 
# File 'lib/qpid_messaging/message.rb', line 40

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

Instance Method Details

#[](key) ⇒ Object

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]



282
 
# File 'lib/qpid_messaging/message.rb', line 282

def [](key); self.properties[key.to_s]; end

#[]=(key, value) ⇒ Object

Assigns a value to the named property.

NOTE: Both the key or the value may be a symbol, but they will both be converted to a String for ease of transport.

Options

  • name - the property name

  • value - the property value



293
 
# File 'lib/qpid_messaging/message.rb', line 293

def []=(key, value); @message_impl.setProperty(key.to_s, value.to_s); end

#content ⇒ Object

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.



342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/qpid_messaging/message.rb', line 342

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) ⇒ Object

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

msg.content = "This is a simple message." # a simple message
msg.content = {:foo => :bar} # content is automatically encoded



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/qpid_messaging/message.rb', line 310

def content=(content)
  content_type = nil
  @content = content
  case @content
  when Hash
    content_type = "amqp/map"
    new_content  = {}
    content.each_pair{|key, value| new_content[key.to_s] = value.to_s}
    @content = new_content
  when Array
    new_content  = []
    content_type = "amqp/list"
    content.each {|element| new_content << element.to_s}
    @content = new_content
  end
  if content_type.nil?
    @message_impl.setContent @content
  else
    Qpid::Messaging.encode @content, self, content_type
  end
end

#content_size ⇒ Object

Returns the content’s size.



359
 
# File 'lib/qpid_messaging/message.rb', line 359

def content_size; @message_impl.getContentSize; end

#content_type ⇒ Object

Returns the content type for the Message.

Examples

case msg.content_type
  when "myapp/image"
    ctl.handle_image msg
    end
  when "myapp/audio"
    ctl.handle_audio msg
    end
end



125
 
# File 'lib/qpid_messaging/message.rb', line 125

def content_type; @message_impl.getContentType; end

#content_type=(content_type) ⇒ Object

Sets the content type for the Message.

This should be set by the sending applicaton and indicates to 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.



110
 
# File 'lib/qpid_messaging/message.rb', line 110

def content_type=(content_type); @message_impl.setContentType content_type; end

#correlation_id ⇒ Object

Returns the correlation id of the Message.

NOTE: See correlation_id= for details.



190
 
# File 'lib/qpid_messaging/message.rb', line 190

def correlation_id; @message_impl.getCorrelationId; end

#correlation_id=(correlation_id) ⇒ Object

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 requestion-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



184
 
# File 'lib/qpid_messaging/message.rb', line 184

def correlation_id=(correlation_id); @message_impl.setCorrelationId correlation_id; end

#durable ⇒ Object

Returns the durability for the Message.



242
 
# File 'lib/qpid_messaging/message.rb', line 242

def durable; @message_impl.getDurable; end

#durable=(durable) ⇒ Object

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 th emessage is not lost during to failures or a shutdown.

Options

  • durable - the durability flag (def. false)



238
 
# File 'lib/qpid_messaging/message.rb', line 238

def durable=(durable); @message_impl.setDurable durable; end

#message_id ⇒ Object

Returns the message id.

See message_id= for details.



144
 
# File 'lib/qpid_messaging/message.rb', line 144

def message_id; @message_impl.getMessageId; end

#message_id=(message_id) ⇒ Object

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



139
 
# File 'lib/qpid_messaging/message.rb', line 139

def message_id=(message_id); @message_impl.setMessageId message_id.to_s; end

#message_impl ⇒ Object

:nodoc:



48
49
50
 
# File 'lib/qpid_messaging/message.rb', line 48

def message_impl # :nodoc:
  @message_impl
end

#priority ⇒ Object

Returns the priority for the Message.



209
 
# File 'lib/qpid_messaging/message.rb', line 209

def priority; @message_impl.getPriority; end

#priority=(priority) ⇒ Object

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



205
 
# File 'lib/qpid_messaging/message.rb', line 205

def priority=(priority); @message_impl.setPriority priority; end

#properties ⇒ Object

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.



269
 
# File 'lib/qpid_messaging/message.rb', line 269

def properties; @message_impl.getProperties; end

#redelivered ⇒ Object

Returns whether the Message has been marked as redelivered.



261
 
# File 'lib/qpid_messaging/message.rb', line 261

def redelivered; @message_impl.getRedelivered; end

#redelivered=(redelivered) ⇒ Object

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 an array of processed message ids
msg.redelivered = true if processed.include? msg.message_id



257
 
# File 'lib/qpid_messaging/message.rb', line 257

def redelivered=(redelivered); @message_impl.setRedelivered redelivered; end

#reply_to ⇒ Object

Returns the reply to address for the Message.



71
72
73
74
75
 
# File 'lib/qpid_messaging/message.rb', line 71

def reply_to
  address_impl = @message_impl.getReplyTo
  # only return an address if a reply to was specified
  Qpid::Messaging::Address.new(nil, nil, nil, nil, address_impl) if address_impl
end

#reply_to=(address) ⇒ Object

Sets the address to which replies should be sent for the Message.

NOTE: The address must be an instance of Address.

Options

  • address - an instance of Address

Examples

msg.reply_to = Qpid:Messaging::Address.new "my-responses"

Raises:

  • (ArgumentError) 


64
65
66
67
 
# File 'lib/qpid_messaging/message.rb', line 64

def reply_to=(address)
  raise ArgumentError, "Agument must be an Address" unless address.is_a? Qpid::Messaging::Address
  @message_impl.setReplyTo address.address_impl
end

#subject ⇒ Object

Returns the subject of the Message.

Options

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



95
 
# File 'lib/qpid_messaging/message.rb', line 95

def subject; @message_impl.getSubject; end

#subject=(subject) ⇒ Object

Sets the subject for the Message.

Options

  • subject - the subject

Examples

msg.subject = "mysubject"



87
 
# File 'lib/qpid_messaging/message.rb', line 87

def subject=(subject); @message_impl.setSubject subject; end

#ttl ⇒ Object

Returns the time-to-live in milliseconds.



226
 
# File 'lib/qpid_messaging/message.rb', line 226

def ttl; Qpid::Messaging::Duration.new @message_impl.getTtl.getMilliseconds; end

#ttl=(duration) ⇒ Object

Sets the time-to-live in milliseconds.

Options

  • duration - the number of milliseconds



217
218
219
220
221
222
223
 
# File 'lib/qpid_messaging/message.rb', line 217

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 ⇒ Object

Returns the user id for the Message.

See user_id= for details.



167
 
# File 'lib/qpid_messaging/message.rb', line 167

def user_id; @message_impl.getUserId; end

#user_id=(user_id) ⇒ Object

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



161
 
# File 'lib/qpid_messaging/message.rb', line 161

def user_id=(user_id); @message_impl.setUserId user_id; end