summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-07-01 09:40:49 +0200
committerfranck cuny <franck@lumberjaph.net>2010-07-01 09:40:49 +0200
commit86ac19e0120e3cd290dcce7c39e6ecf467798c2f (patch)
treeddc9eb6b799905b13cd53d4acb3aec9912501551 /README
parentupdate on stats (diff)
downloadpresque-86ac19e0120e3cd290dcce7c39e6ecf467798c2f.tar.gz
update README
Diffstat (limited to 'README')
-rw-r--r--README76
1 files changed, 0 insertions, 76 deletions
diff --git a/README b/README
deleted file mode 100644
index 0c29bb0..0000000
--- a/README
+++ /dev/null
@@ -1,76 +0,0 @@
-NAME
- presque - a redis/tatsumaki based message queue
-
-SYNOPSIS
-DESCRIPTION
- presque is a persistent job queue that uses Redis for storage and
- Tatsumaki for the interface between workers and Redis.
-
- presque implement a REST interface for communications, and jobs are JSON
- data structure.
-
- Workers can be written in any language as long as they implement the
- REST interface. A complete worker exists for Perl presque::worker. Some
- examples in other languages can be found in the eg directory.
-
- The functionalities are inspired by RestMQ
- <http://github.com/gleicon/restmq> and resque
- <http://github.com/defunkt/resque>.
-
- HTTP ROUTES
- The following HTTP routes are available:
-
- GET /q/queuename
- gets an object out of the queue
-
- POST /q/queuename
- insert an object in the queue
-
- PUT /q/queuename
- re-insert a job after a worker failed to process the job
-
- DELETE /q/queuename
- purge and delete the queue
-
- GET /status/
- informations about a queue.
-
- GET /j/queuename
- return some basic information about a queue.
-
- GET /control/queuename
- return the status of the queue. A queue have two statues: open or
- closed. When a queue is closed, no job can be extracted from the
- queue.
-
- POST /control/queuename
- change the status of the queue.
-
- GET /w/
- some statisctics about a worker
-
- POST /w/queuename
- register a worker on a queue.
-
- DELETE /w/queue_name
- unregister a worker on a queue.
-
-AUTHOR
- franck cuny <franck@lumberjaph.net>
-
-SEE ALSO
- For a complete description of each routes, refer to
- presque::WorkerHandler, presque::RestQueueHandler,
- presque::ControlHandler, presque::JobQueueHandler,
- presque::StatusHandler.
-
- For a complete worker see presque::worker.
-
-LICENSE
- Copyright 2010 by Linkfluence
-
- <http://linkfluence.net>
-
- This library is free software; you can redistribute it and/or modify it
- under the same terms as Perl itself.
-