Object
RightAws::SqsGen2 -- RightScale's Amazon SQS interface, API version 2008-01-01 and later. The RightAws::SqsGen2 class provides a complete interface to the second generation of Amazon's Simple Queue Service. For explanations of the semantics of each call, please refer to Amazon's documentation at developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=31
RightAws::SqsGen2 is built atop RightAws::SqsGen2Interface, a lower-level procedural API that may be appropriate for certain programs.
Error handling: all operations raise an RightAws::AwsError in case of problems. Note that transient errors are automatically retried.
sqs = RightAws::SqsGen2.new(aws_access_key_id, aws_secret_access_key) queue1 = sqs.queue('my_awesome_queue') ... queue2 = RightAws::SqsGen2::Queue.create(sqs, 'my_cool_queue', true) puts queue2.size ... message1 = queue2.receive message1.visibility = 0 puts message1 ... queue2.clear(true) queue2.send_message('Ola-la!') message2 = queue2.pop ...
NB: Second-generation SQS has eliminated the entire access grant mechanism present in Gen 1.
Params is a hash:
{:server => 'queue.amazonaws.com' # Amazon service host: 'queue.amazonaws.com' (default) :port => 443 # Amazon service port: 80 or 443 (default) :signature_version => '0' # The signature version : '0' or '1'(default) :logger => Logger Object} # Logger instance: logs to STDOUT if omitted }
Returns Queue instance by queue name. If the queue does not exist at Amazon SQS and create is true, the method creates it.
RightAws::SqsGen2.queue('my_awesome_queue') #=> #<RightAws::SqsGen2::Queue:0xb7b626e4 ... >
# File lib/sqs/right_sqs_gen2.rb, line 88 def queue(queue_name, create=true, visibility=nil) url = @interface.queue_url_by_name(queue_name) url = (create ? @interface.create_queue(queue_name, visibility) : nil) unless url url ? Queue.new(self, url) : nil end
Generated with the Darkfish Rdoc Generator 2.