c2e4f2f1ab
sed -i 's/Also See/See Also/' plugin/**/README.md Some plugins did already use 'See Also', so it's all consistent now. Fixes: #4196 Signed-off-by: Miek Gieben <miek@miek.nl> |
||
|---|---|---|
| .. | ||
| cancel.go | ||
| cancel_test.go | ||
| README.md | ||
| setup_test.go | ||
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.
Syntax
cancel [TIMEOUT]
- TIMEOUT allows setting a custom timeout. The default timeout is 5001 milliseconds (
5001 ms)
Examples
example.org {
cancel
whoami
}
Or with a custom timeout:
example.org {
cancel 1s
whoami
}
See Also
The Go documentation for the context package.