Skip to content

C
Coredns
Commit ab59b28c authored by Cricket Liu's avatar Cricket Liu Committed by Miek Gieben
Browse files
Options

Making cancel's README consistent with other plugins' READMEs (#3253)

parent b156e044
Hide whitespace changes
Inline Side-by-side
Showing with 2 additions and 2 deletions
plugin/cancel/README.md
View file @ ab59b28c
...@@ -2,14 +2,14 @@ ...@@ -2,14 +2,14 @@
## Name ## Name
*cancel* - a plugin that cancels a request's context after 5001 milliseconds. *cancel* - cancels a request's context after 5001 milliseconds.
## Description ## Description
The *cancel* plugin creates a canceling context for each request. It adds a timeout that gets The *cancel* plugin creates a canceling context for each request. It adds a timeout that gets
triggered after 5001 milliseconds. triggered after 5001 milliseconds.
The 5001 number is chosen because the default timeout for DNS clients is 5 seconds, after that they The 5001 number was chosen because the default timeout for DNS clients is 5 seconds, after that they
give up. give up.
A plugin interested in the cancellation status should call `plugin.Done()` on the context. If the A plugin interested in the cancellation status should call `plugin.Done()` on the context. If the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment