From dff4ce92ad4772e5debaad86f81b830700f499f4 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg <daniel@haxx.se> Date: Thu, 4 Dec 2008 12:54:43 +0000 Subject: [PATCH] the initial version of the ares_set_socket_callback man page --- ares/Makefile.inc | 3 ++- ares/ares_set_socket_callback.3 | 24 ++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 ares/ares_set_socket_callback.3 diff --git a/ares/Makefile.inc b/ares/Makefile.inc index 3f970b86a6..07b71bd71e 100644 --- a/ares/Makefile.inc +++ b/ares/Makefile.inc @@ -19,4 +19,5 @@ MANPAGES= ares_destroy.3 ares_expand_name.3 ares_expand_string.3 ares_fds.3 \ ares_query.3 ares_search.3 ares_send.3 ares_strerror.3 ares_timeout.3 \ ares_version.3 ares_cancel.3 ares_parse_aaaa_reply.3 ares_getnameinfo.3 \ ares_getsock.3 ares_parse_ns_reply.3 ares_dup.3 \ - ares_destroy_options.3 ares_save_options.3 ares_gethostbyname_file.3 + ares_destroy_options.3 ares_save_options.3 ares_gethostbyname_file.3 \ + ares_set_socket_callback.3 diff --git a/ares/ares_set_socket_callback.3 b/ares/ares_set_socket_callback.3 new file mode 100644 index 0000000000..c4f0455772 --- /dev/null +++ b/ares/ares_set_socket_callback.3 @@ -0,0 +1,24 @@ +.\" $Id$ +.\" +.TH ARES_SET_SOCKET_CALLBACK 3 "2 Dec 2008" +.SH NAME +ares_set_socket_callback \- Set a socket creation callback +.SH SYNOPSIS +.nf +int ares_set_socket_callback(ares_channel \fIchannel\fP, + ares_sock_create_callback \fIcallback\fP, + void *\fIuserdata\fP) +.fi +.SH DESCRIPTION +This function sets a \fIcallback\fP in the given ares channel handle. This +callback function will be invoked after the socket has been created, and +connected to the remote server. The callback must return ARES_SUCCESS if +things are fine, or use the standard ares error codes to signal errors +back. Returned errors will abort the ares operation. +.SH SEE ALSO +.BR ares_init_options (3) +.SH AVAILABILITY +ares_set_socket_callback(3) was added in c-ares 1.6.0 +.SH AUTHOR +Gregor Jasny + -- GitLab