Permalink
Browse files

Update the protocol documentation.

  • Loading branch information...
1 parent 7f559c8 commit c47144f95458bfb235660b335739af17e2ea9e0a @etanol etanol committed Sep 13, 2012
Showing with 16 additions and 0 deletions.
  1. +16 −0 doc/protocol.txt
View
@@ -395,6 +395,22 @@ KICKED <count>\r\n
- <count> is an integer indicating the number of jobs actually kicked.
+The kick-job command is a variant of kick that operates with a single job
+identified by its job id. If the given job id exists and is in a buried or
+delayed state, it will be moved to the ready queue of the the same tube where it
+currently belongs. The syntax is:
+
+kick-job <id>\r\n
+
+ - <id> is the job id to kick.
+
+The response is one of:
+
+ - "NOT_FOUND\r\n" if the job does not exist or is not in a kickable state. This
+ can also happen upon internal errors.
+
+ - "KICKED\r\n" when the operation succeeded.
+
The stats-job command gives statistical information about the specified job if
it exists. Its form is:

0 comments on commit c47144f

Please sign in to comment.