the initial version of the ares_set_socket_callback man page

diff --git a/Makefile.inc b/Makefile.inc
index 3f970b8..07b71bd 100644 (file)
--- a/Makefile.inc
+++ b/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_set_socket_callback.3 b/ares_set_socket_callback.3
new file mode 100644 (file)
index 0000000..c4f0455
--- /dev/null
+++ b/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
+