diff options
Diffstat (limited to 'deps/uv/c-ares/ares_cancel.3')
| -rw-r--r-- | deps/uv/c-ares/ares_cancel.3 | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/deps/uv/c-ares/ares_cancel.3 b/deps/uv/c-ares/ares_cancel.3 new file mode 100644 index 0000000000..ef10ec587a --- /dev/null +++ b/deps/uv/c-ares/ares_cancel.3 @@ -0,0 +1,43 @@ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" +.\" Permission to use, copy, modify, and distribute this +.\" software and its documentation for any purpose and without +.\" fee is hereby granted, provided that the above copyright +.\" notice appear in all copies and that both that copyright +.\" notice and this permission notice appear in supporting +.\" documentation, and that the name of M.I.T. not be used in +.\" advertising or publicity pertaining to distribution of the +.\" software without specific, written prior permission. +.\" M.I.T. makes no representations about the suitability of +.\" this software for any purpose. It is provided "as is" +.\" without express or implied warranty. +.\" +.TH ARES_CANCEL 3 "31 March 2004" +.SH NAME +ares_cancel \- Cancel a resolve +.SH SYNOPSIS +.nf +.B #include <ares.h> +.PP +.B void ares_cancel(ares_channel \fIchannel\fP) +.fi +.SH DESCRIPTION +The \fBares_cancel\fP function cancels all lookups/requests made on the the +name service channel identified by \fIchannel\fP. \fBares_cancel\fP invokes +the callbacks for each pending query on the channel, passing a status of +.BR ARES_ECANCELLED . +These calls give the callbacks a chance to clean up any state which +might have been stored in their arguments. +.SH SEE ALSO +.BR ares_init (3) +.BR ares_destroy (3) +.SH NOTES +This function was added in c-ares 1.2.0 + +c-ares 1.6.0 and earlier pass a status of +.BR ARES_ETIMEOUT +instead of +.BR ARES_ECANCELLED . +.SH AUTHOR +Dirk Manske |