Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-27 16:24:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Cricket Liu
2019-09-08 00:26:16 -07:00
committed by Miek Gieben
parent b156e0440f
commit ab59b28c4f
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
plugin/cancel/README.md
View File

@@ -2,14 +2,14 @@
## Name
*cancel* - a plugin that cancels a request's context after 5001 milliseconds.
*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 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.
A plugin interested in the cancellation status should call `plugin.Done()` on the context. If the