luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Adds clarifying note about the wakeup jitter. 

Closes #2727.
This commit is contained in:
James Phillips 2017-02-09 20:28:38 -08:00 committed by GitHub
parent 909364b4b7
commit b88a7eee95
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/source/docs/agent/http.html.markdown
View File

@ -45,7 +45,10 @@ to wait for any changes subsequent to that index.
In addition to `index`, endpoints that support blocking will also honor a `wait`
parameter specifying a maximum duration for the blocking request. This is limited to
10 minutes. If not set, the wait time defaults to 5 minutes. This value can be specified
in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively).
in the form of "10s" or "5m" (i.e., 10 seconds or 5 minutes, respectively). A small random
amount of additional wait time is added to the supplied maximum `wait` time to spread out
the wake up time of any concurrent requests. This adds up to `wait / 16` additional time
to the maximum duration.
A critical note is that the return of a blocking request is **no guarantee** of a change. It
is possible that the timeout was reached or that there was an idempotent write that does