diff options
| author | Adam Olsen | 2016-08-25 17:01:29 -0600 |
|---|---|---|
| committer | Adam Olsen | 2016-08-25 17:03:48 -0600 |
| commit | b0e1a20129d6814e840f5a56ec8b07b1507b1eaf (patch) | |
| tree | 0eeb166bb1aa88e84c28491609744556953b1052 /docs/protocol.rst | |
| parent | 6bcbc67e6e52e49a942a6fe0933511838ee23efd (diff) | |
| download | eventmq-b0e1a20129d6814e840f5a56ec8b07b1507b1eaf.tar.gz eventmq-b0e1a20129d6814e840f5a56ec8b07b1507b1eaf.zip | |
Document "nohaste" header flag
Diffstat (limited to 'docs/protocol.rst')
| -rw-r--r-- | docs/protocol.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/protocol.rst b/docs/protocol.rst index c341403..bf400cc 100644 --- a/docs/protocol.rst +++ b/docs/protocol.rst | |||
| @@ -204,16 +204,17 @@ Heartbeating | |||
| 204 | * If the broker detects that a worker has disconnected it should stop sending it a message of any type. | 204 | * If the broker detects that a worker has disconnected it should stop sending it a message of any type. |
| 205 | * If the scheduler detects that the broker disconnects it SHOULD restart the conversation. | 205 | * If the scheduler detects that the broker disconnects it SHOULD restart the conversation. |
| 206 | 206 | ||
| 207 | REQUEST Headers | 207 | Headers |
| 208 | --------------- | 208 | --------------- |
| 209 | Headers MUST be 0 to many comma seperated values inserted into the header field. If there are no headers required, send an empty string MUST be sent where headers are required. | 209 | Headers MUST be 0 to many comma seperated values inserted into the header field. If there are no headers required, send an empty string MUST be sent where headers are required. |
| 210 | 210 | ||
| 211 | Below is a table which defines and describes the headers. | 211 | Below is a table which defines and describes the headers. |
| 212 | 212 | ||
| 213 | =============== ======= ======= ======= =========== | 213 | ================= ======= ======= ======== ======= =========== |
| 214 | Header REQUEST PUBLISH Default Description | 214 | Header REQUEST PUBLISH SCHEDULE Default Description |
| 215 | =============== ======= ======= ======= =========== | 215 | ================= ======= ======= ======== ======= =========== |
| 216 | reply-requested X False Once the job is finished, send a reply back with information from the job. If there is no information reply with a True value. | 216 | reply-requested X False Once the job is finished, send a reply back with information from the job. If there is no information reply with a True value. |
| 217 | retry-count:# X 0 Retry a failed job this many times before accepting defeat. | 217 | retry-count:# X 0 Retry a failed job this many times before accepting defeat. |
| 218 | guarantee X False Ensure the job completes by letting someone else worry about a success reply. | 218 | guarantee X False Ensure the job completes by letting someone else worry about a success reply. |
| 219 | =============== ======= ======= ======= =========== | 219 | nohaste X False When scheduling a job, set this to True if you don't want the job to run immediately as it's scheduled. Instead, it will run for the first time when the interval has elapsed. |
| 220 | ================= ======= ======= ======== ======= =========== | ||