summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ROUTES37
-rw-r--r--lib/presque/JobQueueHandler.pm4
2 files changed, 40 insertions, 1 deletions
diff --git a/ROUTES b/ROUTES
new file mode 100644
index 0000000..1dff148
--- /dev/null
+++ b/ROUTES
@@ -0,0 +1,37 @@
+#+TITLE: PRESQUE ROUTES
+
+** GET /
+ "dashboard"
+
+** GET /q/:queue_name?worker_id
+ fetch a job from a queue
+
+** DELETE /q/:queue_name
+ delete a queue
+
+** POST /q/:queue_name
+ create a new job
+
+** PUT /q/:queue_name
+ mark a job as failed
+
+** GET /j/:queue_name
+ get some stats about a queue
+
+** GET /w/
+ get some stats for a queue
+
+** POST /w/:queue_name
+ register a worker on a queue
+
+** DELETE /w/:queue_name
+ unregister a worker on a queue
+
+** GET /status/:queue_name
+ get the size of a queue
+
+** GET /control/:queue_name
+ is the queue open or closed ?
+
+** POST /control/:queue_name
+ close or open a queue
diff --git a/lib/presque/JobQueueHandler.pm b/lib/presque/JobQueueHandler.pm
index 8791655..cb544b9 100644
--- a/lib/presque/JobQueueHandler.pm
+++ b/lib/presque/JobQueueHandler.pm
@@ -46,7 +46,9 @@ __END__
=head1 NAME
-presque::IndexHandler - a redis based message queue
+presque::JobQueueHandler
+
+=head1 SYNOPSIS
=head1 DESCRIPTION