summaryrefslogtreecommitdiff
path: root/ares_cancel.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2004-04-01 08:25:58 (GMT)
committerDaniel Stenberg <daniel@haxx.se>2004-04-01 08:25:58 (GMT)
commit86ae23430cb79b38dec419ebf9cf3f85073e091c (patch)
tree47daf64ba656da8b9c0258c69a4c9b627a0aec96 /ares_cancel.3
parent8ede9dd9c9f899707feec5345ef7dee79dc3674a (diff)
downloadc-ares-86ae23430cb79b38dec419ebf9cf3f85073e091c.zip
c-ares-86ae23430cb79b38dec419ebf9cf3f85073e091c.tar.gz
c-ares-86ae23430cb79b38dec419ebf9cf3f85073e091c.tar.bz2
Dirk Manske's ares_cancel() function was added.
Diffstat (limited to 'ares_cancel.3')
-rw-r--r--ares_cancel.337
1 files changed, 37 insertions, 0 deletions
diff --git a/ares_cancel.3 b/ares_cancel.3
new file mode 100644
index 0000000..fed7e40
--- /dev/null
+++ b/ares_cancel.3
@@ -0,0 +1,37 @@
+.\" $Id$
+.\"
+.\" 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 int 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_ETIMEOUT .
+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 AUTHOR
+Dirk Manske