mirror of
https://github.com/coredns/coredns.git
synced 2025-11-02 02:03:13 -05:00
62317c3c14
Update all documentation in the tree to use example.org as an example configuration (in so far possible). As to get out of the just use "." and fallthrough and things would be fine. Signed-off-by: Miek Gieben <miek@miek.nl>
46 lines
981 B
Markdown
46 lines
981 B
Markdown
# cancel
|
|
|
|
## Name
|
|
|
|
*cancel* - cancels a request's context after 5001 milliseconds.
|
|
|
|
## Description
|
|
|
|
The *cancel* plugin creates a canceling context for each request. It adds a timeout that gets
|
|
triggered after 5001 milliseconds.
|
|
|
|
The 5001 number was chosen because the default timeout for DNS clients is 5 seconds, after that they
|
|
give up.
|
|
|
|
A plugin interested in the cancellation status should call `plugin.Done()` on the context. If the
|
|
context was canceled due to a timeout the plugin should not write anything back to the client and
|
|
return a value indicating CoreDNS should not either; a zero return value should suffice for that.
|
|
|
|
~~~ txt
|
|
cancel [TIMEOUT]
|
|
~~~
|
|
|
|
* **TIMEOUT** allows setting a custom timeout. The default timeout is 5001 milliseconds (`5001 ms`)
|
|
|
|
## Examples
|
|
|
|
~~~ corefile
|
|
example.org {
|
|
cancel
|
|
whoami
|
|
}
|
|
~~~
|
|
|
|
Or with a custom timeout:
|
|
|
|
~~~ corefile
|
|
example.org {
|
|
cancel 1s
|
|
whoami
|
|
}
|
|
~~~
|
|
|
|
## Also See
|
|
|
|
The Go documentation for the context package.
|