Class: Shoryuken::Queue

Inherits:
Object
  • Object
show all
Defined in:
lib/shoryuken/queue.rb

Constant Summary collapse

FIFO_ATTR = 
'FifoQueue'
MESSAGE_GROUP_ID = 
'ShoryukenMessage'
VISIBILITY_TIMEOUT_ATTR = 
'VisibilityTimeout'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, name) ⇒ Queue

Returns a new instance of Queue.



9
10
11
12
13
14
15
 
# File 'lib/shoryuken/queue.rb', line 9

def initialize(client, name)
  self.name   = name
  self.client = client
  self.url    = client.get_queue_url(queue_name: name).queue_url
rescue Aws::SQS::Errors::NonExistentQueue => e
  raise e, "The specified queue '#{name}' does not exist."
end

Instance Attribute Details

#client ⇒ Object

Returns the value of attribute client.



7
8
9
 
# File 'lib/shoryuken/queue.rb', line 7

def client
  @client
end

#name ⇒ Object

Returns the value of attribute name.



7
8
9
 
# File 'lib/shoryuken/queue.rb', line 7

def name
  @name
end

#url ⇒ Object

Returns the value of attribute url.



7
8
9
 
# File 'lib/shoryuken/queue.rb', line 7

def url
  @url
end

Instance Method Details

#delete_messages(options) ⇒ Object 



21
22
23
 
# File 'lib/shoryuken/queue.rb', line 21

def delete_messages(options)
  client.delete_message_batch(options.merge(queue_url: url))
end

#fifo? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/shoryuken/queue.rb', line 43

def fifo?
  @_fifo ||= queue_attributes.attributes[FIFO_ATTR] == 'true'
end

#receive_messages(options) ⇒ Object 



37
38
39
40
41
 
# File 'lib/shoryuken/queue.rb', line 37

def receive_messages(options)
  client.receive_message(options.merge(queue_url: url)).
    messages.
    map { |m| Message.new(client, self, m) }
end

#send_message(options) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/shoryuken/queue.rb', line 25

def send_message(options)
  options = sanitize_message!(options).merge(queue_url: url)

  Shoryuken.client_middleware.invoke(options) do
    client.send_message(options)
  end
end

#send_messages(options) ⇒ Object 



33
34
35
 
# File 'lib/shoryuken/queue.rb', line 33

def send_messages(options)
  client.send_message_batch(sanitize_messages!(options).merge(queue_url: url))
end

#visibility_timeout ⇒ Object 



17
18
19
 
# File 'lib/shoryuken/queue.rb', line 17

def visibility_timeout
  queue_attributes.attributes[VISIBILITY_TIMEOUT_ATTR].to_i
end