b780f49ccf
each readme starts with the plugin's name as a header, this needs to be chopped off to provide a good manual page. Signed-off-by: Miek Gieben <miek@miek.nl>
66 lines
1.1 KiB
Groff
66 lines
1.1 KiB
Groff
.\" Generated by Mmark Markdown Processer - mmark.nl
|
|
.TH "COREDNS-CANCEL" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
|
|
|
.SH NAME
|
|
.PP
|
|
\fIcancel\fP - a plugin that cancels a request's context after 5001 milliseconds.
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \fIcancel\fP plugin creates a canceling context for each request. It adds a timeout that gets
|
|
triggered after 5001 milliseconds.
|
|
|
|
.PP
|
|
The 5001 number is chosen because the default timeout for DNS clients is 5 seconds, after that they
|
|
give up.
|
|
|
|
.PP
|
|
A plugin interested in the cancellation status should call \fB\fCplugin.Done()\fR 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.
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
cancel [TIMEOUT]
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.IP \(bu 4
|
|
\fBTIMEOUT\fP allows setting a custom timeout. The default timeout is 5001 milliseconds (\fB\fC5001 ms\fR)
|
|
|
|
|
|
.SH EXAMPLES
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
cancel
|
|
whoami
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.PP
|
|
Or with a custom timeout:
|
|
|
|
.PP
|
|
.RS
|
|
|
|
.nf
|
|
\&. {
|
|
cancel 1s
|
|
whoami
|
|
}
|
|
|
|
.fi
|
|
.RE
|
|
|
|
.SH ALSO SEE
|
|
.PP
|
|
The Go documentation for the context package.
|
|
|