Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the queues docs. listing of queue resources is now possible. #353

Merged
merged 2 commits into from
Apr 17, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/queues.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,16 @@ Queues require a unique name. If you try to create a queue with a name that alre

queue = pq.create("my_unique_queue")

There is currently no way to list existing queues, so if you need to determine whether a queue by a specific name exists, call:
If you wish to check a given queue already exists, you may do so as follows:

exists = pq.queue_exists("name_to_check")

This call returns `True` or `False`, depending on the existence of a queue with the given name.

## Listing queues
The code below shows how you can list all the queues in a given region:

qs = pyrax.queues.list()

## Posting a Message to a Queue
Messages can be any type of data, as long as they do not exceed 256 KB in length. The message body can be simple values, or a chunk of XML, or a list of JSON values, or anything else. pyrax handles the JSON-encoding required to post the message.
Expand Down