Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 594 lines (401 sloc) 24.58 kb
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
1 # Beanstalkd
2
3 ## Protocol
4
5 ### Description
6
7 The beanstalk protocol runs over TCP using ASCII encoding. Clients connect, send commands and data, wait for responses, and close the connection. For each connection, the server processes commands serially in the order in which they were received and sends responses in the same order. All integers in the protocol are formatted in decimal and (unless otherwise indicated) nonnegative.
8
9 ### Name convention
10
11 Names only supports ASCII strings.
12
13 #### Characters Allowed
14
15 * **letters** (A-Z and a-z)
16 * **numerals** (0-9)
17 * **hyphen** ("-")
18 * **plus** ("+")
19 * **slash** ("/")
20 * **semicolon** (";")
21 * **dot** (".")
22 * **dollar-sign** ("$")
23 * **underscore** ("_")
24 * **parentheses** ("*(*" and "*)*")
25
26 **Notice:** They may not begin with a hyphen and they are terminated by white space (either a space char or end of line). Each name must be at least one character long.
27
28 ### Errors
29
30 | Errors | Description |
31 | --------------------| ------------- |
32 | `OUT_OF_MEMORY\r\n` | The server cannot allocate enough memory for the job. The client should try again later.|
33 | `INTERNAL_ERROR\r\n` | This indicates a bug in the server. It should never happen. If it does happen, please report it at http://groups.google.com/group/beanstalk-talk. |
34 | `BAD_FORMAT\r\n` | The client sent a command line that was not well-formed. This can happen if the line does not end with \r\n, if non-numeric characters occur where an integer is expected, if the wrong number of arguments are present, or if the command line is mal-formed in any other way. |
35 | `UNKNOWN_COMMAND\r\n` | The client sent a command that the server does not know. |
36
37
38 ### Job Lifecycle
39
205548f Nico Taing [doc] fix job lifecycle description
nicotaing authored
40 A job in beanstalk gets created by a client with the `put` command. During its life it can be in one of four states: `ready`, `reserved`, `delayed`, or `buried`. After the `put` command, a job typically starts out ready. It waits in the ready queue until a worker comes along and runs the "reserve" command. If this job is next in the queue, it will be reserved for the worker. The worker will execute the job; when it is finished the worker will send a `delete` command to delete the job.
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
41
42 | Status | Description |
43 | --------------------| ------------- |
205548f Nico Taing [doc] fix job lifecycle description
nicotaing authored
44 | `ready` | waiting to be reserved and processed after being put onto a tubed |
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
45 | `reserved` | if this job is next in the queue, it will be reserved for the worker. The worker will execute the job |
205548f Nico Taing [doc] fix job lifecycle description
nicotaing authored
46 | `delayed` | waiting to become ready after the specified delay. |
47 | `buried` | waiting to be kicked, usually after job fails to process |
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
48
49 Here is a picture of the typical job lifecycle:
50
51 ```
52 put reserve delete
53 -----> [READY] ---------> [RESERVED] --------> *poof*
54 ```
55
56
57
58 Here is a picture with more possibilities:
59
60 ```
61 put with delay release with delay
62 ----------------> [DELAYED] <------------.
63 | |
7b81226 Karen Etheridge show the delayed->ready transition via 'kick'
karenetheridge authored
64 kick | (time passes) |
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
65 | |
66 put v reserve | delete
67 -----------------> [READY] ---------> [RESERVED] --------> *poof*
68 ^ ^ | |
69 | \ release | |
70 | `-------------' |
71 | |
72 | kick |
73 | |
74 | bury |
75 [BURIED] <---------------'
76 |
77 | delete
78 `--------> *poof*
79 ```
80
81 ### Tubes
82
83 The system has one or more tubes. Each tube consists of a ready queue and a delay queue. Each job spends its entire life in one tube. Consumers can show interest in tubes by sending the `watch` command; they can show disinterest by sending the `ignore` command. This set of interesting tubes is said to be a consumer's `watch list`. When a client reserves a job, it may come from any of the tubes in its watch list.
84
85 When a client connects, its watch list is initially just the tube named `default`. If it submits jobs without having sent a `use` command, they will live in the tube named `default`.
86
87 Tubes are created on demand whenever they are referenced. If a tube is empty (that is, it contains no `ready`, `delayed`, or `buried` jobs) and no client refers to it, it will be deleted.
88
89 ## Commands
90
91 ### Producer Commands
92
93 #### `put` command
94
95 The `put` command is for any process that wants to insert a job into the queue. It comprises a command line followed by the job body:
96
97 ```
98 put <pri> <delay> <ttr> <bytes>\r\n
99 <data>\r\n
100 ```
101
102 #####`put` options
103
104 It inserts a job into the client's currently used tube (see the `use` command below).
105
106 * `<pri>` is an integer < 2**32. Jobs with smaller priority values will be scheduled before jobs with larger priorities. The most urgent priority is 0;the least urgent priority is 4,294,967,295.
107 * `<delay>` is an integer number of seconds to wait before putting the job in the ready queue. The job will be in the "delayed" state during this time.
108 * `<ttr>` -- time to run -- is an integer number of seconds to allow a worker to run this job. This time is counted from the moment a worker reserves this job. If the worker does not delete, release, or bury the job within `<ttr>` seconds, the job will time out and the server will release the job. The minimum ttr is 1. If the client sends 0, the server will silently increase the ttr to 1.
109 * `<bytes>` is an integer indicating the size of the job body, not including the trailing "\r\n". This value must be less than max-job-size (default: 2**16).
110 * `<data>` is the job body -- a sequence of bytes of length <bytes> from the previous line.
111
112
113 ##### `put` responses
114 After sending the command line and body, the client waits for a reply, which
115 may be:
116
117 * `INSERTED <id>\r\n` to indicate success. `<id>` is the integer id of the new job
118 * `BURIED <id>\r\n` if the server ran out of memory trying to grow the priority queue data structure. `<id>` is the integer id of the new job
119 * `EXPECTED_CRLF\r\n` The job body must be followed by a CR-LF pair, that is, `"\r\n"`. These two bytes are not counted in the job size given by the client in the put command line.
120 * `JOB_TOO_BIG\r\n` The client has requested to put a job with a body larger than max-job-size bytes.
121 * `DRAINING\r\n` This means that the server has been put into "drain mode" and is no longer accepting new jobs. The client should try another server or disconnect and try again later.
122
123 #### `use` command
124
125 The `use` command is for producers. Subsequent put commands will put jobs into the tube specified by this command. If no use command has been issued, jobs will be put into the tube named `default`.
126
127 ```
128 use <tube>\r\n
129 ```
130
131 ##### `use` options
132
133 * `<tube>` is a name at most 200 bytes. It specifies the tube to use. If the tube does not exist, it will be created.
134
135 ##### `use` responses
136
137 * `USING <tube>\r\n` -- `<tube>` is the name of the tube now being used.
138
bf4dd7a Nico Taing [protocol.md] add bury description
nicotaing authored
139 ### Worker Commands
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
140
141 A process that wants to consume jobs from the queue uses those commands:
142
143 * `reserve`
144 * `delete`
145 * `release`
146 * `bury`
147
148 #### `reserve` command
149
150 ```
151 reserve\r\n
152 ```
153
154 Alternatively, you can specify a timeout as follows:
155
156 ```
157 reserve-with-timeout <seconds>\r\n
158 ```
159
160 This will return a newly-reserved job. If no job is available to be reserved, beanstalkd will wait to send a response until one becomes available. Once a job is reserved for the client, the client has limited time to run (TTR) the job before the job times out. When the job times out, the server will put the job back into the ready queue. Both the TTR and the actual time left can be found in response to the `stats-job` command.
161
162 A timeout value of `0` will cause the server to immediately return either a response or `TIMED_OUT`. A positive value of timeout will limit the amount of time the client will block on the reserve request until a job becomes available.
163
164 ##### `reserve` responses
165
166 ###### Non-succesful responses
167
168 * `DEADLINE_SOON\r\n` During the TTR of a reserved job, the last second is kept by the server as a safety margin, during which the client will not be made to wait for another job. If the client issues a reserve command during the safety margin, or if the safety margin arrives while the client is waiting on a reserve command.
c2ee0f3 Keith Rarick correctly check for hangup during reserve
authored
169 * `TIMED_OUT\r\n` If a non-negative timeout was specified and the timeout exceeded before a job became available, or if the client's connection is half-closed, the server will respond with TIMED_OUT.
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
170
171 Otherwise, the only other response to this command is a successful reservation
172 in the form of a text line followed by the job body:
173
174 ####### Succesful response
175
176
177 ```
178 RESERVED <id> <bytes>\r\n
179 <data>\r\n
180 ```
181
182 * `<id>` is the job id -- an integer unique to this job in this instance of beanstalkd.
183 * `<bytes>` is an integer indicating the size of the job body, not including the trailing `\r\n"`.
184 * `<data>` is the job body -- a sequence of bytes of length <bytes> from the previous line. This is a verbatim copy of the bytes that were originally sent to the server in the put command for this job.
185
186 #### `delete` command
187
188 The delete command removes a job from the server entirely. It is normally used by the client when the job has successfully run to completion. A client can delete jobs that it has `reserved`, `ready` jobs, `delayed` jobs, and jobs that are
189 `buried`. The delete command looks like this:
190
191 ```
192 delete <id>\r\n
193 ```
194
195 ##### `delete` options
196
197 * `<id>` is the job id to delete.
198
199 ##### `delete` responses
200
201 The client then waits for one line of response, which may be:
202
203 * `DELETED\r\n` to indicate success.
204 * `NOT_FOUND\r\n` if the job does not exist or is not either reserved by the client, ready, or buried. This could happen if the job timed out before the client sent the delete command.
205
206 #### `release` command
207
208 The release command puts a `reserved` job back into the ready queue (and marks its state as `ready`) to be run by any client. It is normally used when the job fails because of a transitory error. It looks like this:
209
210 ```
211 release <id> <pri> <delay>\r\n
212 ```
213
214 ##### `release` options
215
216 * `<id>` is the job id to release.
217 * `<pri>` is a new priority to assign to the job.
218 * `<delay>` is an integer number of seconds to wait before putting the job in the ready queue. The job will be in the "delayed" state during this time.
219
220 ##### `release` responses
221
222 The client expects one line of response, which may be:
223
224 * `RELEASED\r\n` to indicate success.
225 * `BURIED\r\n` if the server ran out of memory trying to grow the priority queue data structure.
226 * `NOT_FOUND\r\n` if the job does not exist or is not reserved by the client.
227
bf4dd7a Nico Taing [protocol.md] add bury description
nicotaing authored
228 #### `bury` command
229 The bury command puts a job into the "buried" state. Buried jobs are put into a FIFO linked list and will not be touched by the server again until a client kicks them with the `kick`" command.
230
231 The bury command looks like this:
232
233 ```
234 bury <id> <pri>\r\n
235 ```
236
237 ##### `bury` options
238
239 * `<id>` is the job id to release.
240 * `<pri>` is a new priority to assign to the job.
241
242 ##### `bury` responses
243
244 There are two possible responses:
245
246 * `BURIED\r\n` to indicate success.
247 * `NOT_FOUND\r\n` if the job does not exist or is not reserved by the client.
248
249
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
250 #### `touch` command
251
252 The `touch` command allows a worker to request more time to work on a job. This is useful for jobs that potentially take a long time, but you still want the benefits of a TTR pulling a job away from an unresponsive worker. A worker may periodically tell the server that it's still alive and processing a job (e.g. it may do this on `DEADLINE_SOON`).
253
254 The touch command looks like this:
255
256 ```
257 touch <id>\r\n
258 ```
259
260 ##### `touch` options
261
262 * `<id>` is the ID of a job reserved by the current connection.
263
264 ##### `touch` responses
265
266 There are two possible responses:
267
268 * `TOUCHED\r\n` to indicate success.
269 * `NOT_FOUND\r\n` if the job does not exist or is not reserved by the client.
270
271 #### `watch` command
272
273 The `watch` command adds the named tube to the watch list for the current connection. A reserve command will take a job from any of the tubes in the watch list. For each new connection, the watch list initially consists of one tube, named `default`.
274
275 ```
276 watch <tube>\r\n
277 ```
278
279 ##### `watch` options
280
281 * `<tube>` is a name at most 200 bytes. It specifies a tube to add to the watch list. If the tube doesn't exist, it will be created.
282
283 ##### `watch` responses
284
285 The reply is:
286
287 * `WATCHING <count>\r\n` `<count>` is the integer number of tubes currently in the watch list.
288
289 ##### `ignore` command
290
291 The `ignore` command is for consumers. It removes the named tube from the watch list for the current connection.
292
293 ```
294 ignore <tube>\r\n
295 ```
296
297 ##### `ignore` options
298
299 * `<tube>` is a name at most 200 bytes. It specifies a tube to add to the watch list. If the tube doesn't exist, it will be created.
300
301 ##### `ignore` command
302
303 The reply is one of:
304
305 * `WATCHING <count>\r\n` to indicate success. `<count>` is the integer number of tubes currently in the watch list.
306 * `NOT_IGNORED\r\n` if the client attempts to ignore the only tube in its watch list.
307
308 ### Other Commands
309
310 #### `peek` command
311
312 The peek commands let the client inspect a job in the system. There are four variations. All but the first operate only on the currently used tube.
313
314 * `peek <id>\r\n` - return `job <id>`.
315 * `peek-ready\r\n` - return the next ready job.
316 * `peek-delayed\r\n` - return the delayed job with the shortest delay left.
317 * `peek-buried\r\n` - return the next job in the list of buried jobs.
318
319 ##### `peek` responses
320
321 There are two possible responses, either a single line:
322
323 * `NOT_FOUND\r\n` if the requested job doesn't exist or there are no jobs in the requested state.
324 * `FOUND <id> <bytes>\r\n <data>\r\n`
325 * `<id>` is the job id.
326 * `<bytes>` is an integer indicating the size of the job body, not including the trailing `\r\n`.
327 * `<data>` is the job body -- a sequence of bytes of length <bytes> from the previous line.
328
329 #### `kick` command
330
331 The kick command applies only to the currently used tube. It moves jobs into the ready queue. If there are any buried jobs, it will only kick buried jobs. Otherwise it will kick delayed jobs. It looks like:
332
333 ```
334 kick <bound>\r\n
335 ```
336
337 ##### `kick` options
338
339 * `<bound>` is an integer upper bound on the number of jobs to kick. The server will kick no more than <bound> jobs.
340
341 ##### `kick` responses
342
343 The response is of the form:
344
345 * `KICKED <count>\r\n`
346 * <count> is an integer indicating the number of jobs actually kicked.
347
348 #### `kick-job` command
349
350 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:
351
352 ```
353 kick-job <id>\r\n
354 ```
355
356 ##### `kick-job` options
357
358 * <id> is the job id to kick.
359
360 ##### `kick-job` responses
361
362 The response is one of:
363
364 * `NOT_FOUND\r\n` if the job does not exist or is not in a kickable state. This can also happen upon internal errors.
365 * `KICKED\r\n` when the operation succeeded.
366
2e6d305 Joel Bradshaw Fixing a few "stats-jobs" typos
cincodenada authored
367 #### `stats-job` command
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
368
369 The stats-job command gives statistical information about the specified job if it exists. Its form is:
370
371 ```
372 stats-job <id>\r\n
373 ```
374
2e6d305 Joel Bradshaw Fixing a few "stats-jobs" typos
cincodenada authored
375 ##### `stats-job` options
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
376
377 * `<id>` is a job id.
378
2e6d305 Joel Bradshaw Fixing a few "stats-jobs" typos
cincodenada authored
379 ##### `stats-job` responses
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
380
381 The response is one of:
382
383 * `NOT_FOUND\r\n` if the job does not exist.
384 * `OK <bytes>\r\n<data>\r\n`
385 * `<bytes>` is the size of the following data section in bytes.
386 * `<data>` is a sequence of bytes of length `<bytes>` from the previous line. It is a YAML file with statistical information represented a dictionary.
387
388 The `stats-job` data is a YAML file representing a single dictionary of strings to scalars. It contains these keys:
389
390 * `id` is the job id
391 * `tube` is the name of the tube that contains this job
392 * `state` is `ready` or `delayed` or `reserved` or `buried`
393 * `pri` is the priority value set by the put, release, or bury commands.
394 * `age` is the time in seconds since the put command that created this job.
395 * `time-left` is the number of seconds left until the server puts this job into the ready queue. This number is only meaningful if the job is reserved or delayed. If the job is reserved and this amount of time elapses before its state changes, it is considered to have timed out.
396 * `file` is the number of the earliest binlog file containing this job. If -b wasn't used, this will be 0.
397 * `reserves` is the number of times this job has been reserved.
398 * `timeouts` is the number of times this job has timed out during a reservation.
399 * `releases` is the number of times a client has released this job from a reservation.
400 * `buries` is the number of times this job has been buried.
401 * `kicks` is the number of times this job has been kicked.
402
403 #### `stats-tube` command
404
405 The stats-tube command gives statistical information about the specified tube if it exists. Its form is:
406
407 ```
408 stats-tube <tube>\r\n
409 ```
410
411 ##### `stats-tube` options
412
413 * `<tube>` is a name at most 200 bytes. Stats will be returned for this tube.
414
415 ##### `stats-tube` responses
416
417 The response is one of:
418
419 * `NOT_FOUND\r\n` if the tube does not exist.
420 * `OK <bytes>\r\n<data>\r\n`
421 * `<bytes>` is the size of the following data section in bytes.
422 * `<data>` is a sequence of bytes of length `<bytes>` from the previous line. It is a YAML file with statistical information represented a dictionary.
423
424 The stats-tube data is a YAML file representing a single dictionary of strings to scalars. It contains these keys:
425
426 * `name` is the tube's name.
427 * `current-jobs-urgent` is the number of ready jobs with priority < 1024 in this tube.
428 * `current-jobs-ready` is the number of jobs in the ready queue in this tube.
429 * `current-jobs-reserved` is the number of jobs reserved by all clients in this tube.
430 * `current-jobs-delayed` is the number of delayed jobs in this tube.
431 * `current-jobs-buried` is the number of buried jobs in this tube.
432 * `total-jobs` is the cumulative count of jobs created in this tube in the current beanstalkd process.
433 * `current-using` is the number of open connections that are currently using this tube.
434 * `current-waiting` is the number of open connections that have issued a reserve command while watching this tube but not yet received a response.
435 * `current-watching` is the number of open connections that are currently watching this tube.
436 * `pause` is the number of seconds the tube has been paused for.
437 * `cmd-delete` is the cumulative number of delete commands for this tube
438 * `cmd-pause-tube` is the cumulative number of pause-tube commands for this tube.
439 * `pause-time-left` is the number of seconds until the tube is un-paused.
440
441 #### `stats` command
442
443 The stats command gives statistical information about the system as a whole. Its form is:
444
445 ```
446 stats\r\n
447 ```
448
449 ##### `stats` responses
450
451 The server will respond:
452
453 ```
454 OK <bytes>\r\n
455 <data>\r\n
456 ```
457
458 * `<bytes>` is the size of the following data section in bytes.
459 * `<data>` is a sequence of bytes of length <bytes> from the previous line. It is a YAML file with statistical information represented a dictionary.
460
461 The stats data for the system is a YAML file representing a single dictionary of strings to scalars. Entries described as "cumulative" are reset when the beanstalkd process starts; they are not stored on disk with the -b flag.
462
463 * `current-jobs-urgent` is the number of ready jobs with priority < 1024.
464 * `current-jobs-ready` is the number of jobs in the ready queue.
465 * `current-jobs-reserved` is the number of jobs reserved by all clients.
466 * `current-jobs-delayed` is the number of delayed jobs.
467 * `current-jobs-buried` is the number of buried jobs.
468 * `cmd-put` is the cumulative number of put commands.
469 * `cmd-peek` is the cumulative number of peek commands.
470 * `cmd-peek-ready` is the cumulative number of peek-ready commands.
471 * `cmd-peek-delayed` is the cumulative number of peek-delayed commands.
472 * `cmd-peek-buried` is the cumulative number of peek-buried commands.
473 * `cmd-reserve` is the cumulative number of reserve commands.
474 * `cmd-use` is the cumulative number of use commands.
475 * `cmd-watch` is the cumulative number of watch commands.
476 * `cmd-ignore` is the cumulative number of ignore commands.
477 * `cmd-delete` is the cumulative number of delete commands.
478 * `cmd-release` is the cumulative number of release commands.
479 * `cmd-bury` is the cumulative number of bury commands.
480 * `cmd-kick` is the cumulative number of kick commands.
481 * `cmd-stats` is the cumulative number of stats commands.
482 * `cmd-stats-job` is the cumulative number of stats-job commands.
483 * `cmd-stats-tube` is the cumulative number of stats-tube commands.
484 * `cmd-list-tubes` is the cumulative number of list-tubes commands.
485 * `cmd-list-tube-used` is the cumulative number of list-tube-used commands.
486 * `cmd-list-tubes-watched` is the cumulative number of list-tubes-watched commands.
76adfd9 Keith Rarick don't over-specify the format of stats id field
authored
487 * `cmd-pause-tube` is the cumulative number of pause-tube commands.
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
488 * `job-timeouts` is the cumulative count of times a job has timed out.
489 * `total-jobs` is the cumulative count of jobs created.
490 * `max-job-size` is the maximum number of bytes in a job.
491 * `current-tubes` is the number of currently-existing tubes.
492 * `current-connections` is the number of currently open connections.
493 * `current-producers` is the number of open connections that have each issued at least one put command.
494 * `current-workers` is the number of open connections that have each issued at least one reserve command.
495 * `current-waiting` is the number of open connections that have issued a reserve command but not yet received a response.
496 * `total-connections` is the cumulative count of connections.
497 * `pid` is the process id of the server.
498 * `version` is the version string of the server.
499 * `rusage-utime` is the cumulative user CPU time of this process in seconds and microseconds.
500 * `rusage-stime` is the cumulative system CPU time of this process in seconds and microseconds.
501 * `uptime` is the number of seconds since this server process started running.
76adfd9 Keith Rarick don't over-specify the format of stats id field
authored
502 * `binlog-oldest-index` is the index of the oldest binlog file needed to store the current jobs.
503 * `binlog-current-index` is the index of the current binlog file being written to. If binlog is not active this value will be 0.
504 * `binlog-max-size` is the maximum size in bytes a binlog file is allowed to get before a new binlog file is opened.
505 * `binlog-records-written` is the cumulative number of records written to the binlog.
506 * `binlog-records-migrated` is the cumulative number of records written as part of compaction.
507 * `id` is a random id string for this server process, generated when each beanstalkd process starts.
508 * `hostname` is the hostname of the machine as determined by uname.
37db4e0 Nico Taing [doc] add protocol.md
nicotaing authored
509
510 #### `list-tubes` command
511
512 The list-tubes command returns a list of all existing tubes. Its form is:
513
514 ```
515 list-tubes\r\n
516 ```
517
518 ##### `list-tubes` responses
519
520 The response is:
521
522 ```
523 OK <bytes>\r\n
524 <data>\r\n
525 ```
526
527 * `<bytes>` is the size of the following data section in bytes.
528 * `<data>` is a sequence of bytes of length <bytes> from the previous line. It is a YAML file containing all tube names as a list of strings.
529
530 #### `list-tube-used` command
531
532 The list-tube-used command returns the tube currently being used by the client. Its form is:
533
534 ```
535 list-tube-used\r\n
536 ```
537
538 ##### `list-tube-used` responses
539 The response is:
540
541 ```
542 USING <tube>\r\n
543 ```
544
545 * `<tube>` is the name of the tube being used.
546
547 #### `list-tubes-watched` command
548
549 The list-tubes-watched command returns a list tubes currently being watched by the client. Its form is:
550
551 ```
552 list-tubes-watched\r\n
553 ```
554
555 ##### `list-tubes-watched` responses
556
557 The response is:
558
559 ```
560 OK <bytes>\r\n
561 <data>\r\n
562 ```
563
564 * `<bytes>` is the size of the following data section in bytes.
565 * `<data>` is a sequence of bytes of length <bytes> from the previous line. It is a YAML file containing watched tube names as a list of strings.
566
567 #### `quit` command
568
569 The quit command simply closes the connection. Its form is:
570
571 ```
572 quit\r\n
573 ```
574
575 #### `pause-tube` command
576
577 The pause-tube command can delay any new job being reserved for a given time. Its form is:
578
579 ```
580 pause-tube <tube-name> <delay>\r\n
581 ```
582
583 ##### `pause-tube` options
584
585 * `<tube>` is the tube to pause
586 * `<delay>` is an integer number of seconds to wait before reserving any more jobs from the queue
587
588 ##### `pause-tube` responses
589
590 There are two possible responses:
591
592 * `PAUSED\r\n` to indicate success.
2e6d305 Joel Bradshaw Fixing a few "stats-jobs" typos
cincodenada authored
593 * `NOT_FOUND\r\n` if the tube does not exist.
Something went wrong with that request. Please try again.