summaryrefslogtreecommitdiff
path: root/ares_set_socket_callback.3
diff options
context:
space:
mode:
Diffstat (limited to 'ares_set_socket_callback.3')
-rw-r--r--ares_set_socket_callback.328
1 files changed, 28 insertions, 0 deletions
diff --git a/ares_set_socket_callback.3 b/ares_set_socket_callback.3
new file mode 100644
index 0000000..68e608b
--- /dev/null
+++ b/ares_set_socket_callback.3
@@ -0,0 +1,28 @@
+.\"
+.TH ARES_SET_SOCKET_CALLBACK 3 "20 Nov 2009"
+.SH NAME
+ares_set_socket_callback \- Set a socket creation callback
+.SH SYNOPSIS
+.nf
+.B #include <ares.h>
+.PP
+.B void ares_set_socket_callback(ares_channel \fIchannel\fP,
+ ares_sock_create_callback \fIcallback\fP,
+ void *\fIuserdata\fP)
+.PP
+.B cc file.c -lcares
+.fi
+.SH DESCRIPTION
+.PP
+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
+