aboutsummaryrefslogtreecommitdiff
path: root/ares/ares_set_socket_callback.3
diff options
context:
space:
mode:
authorYang Tse <yangsita@gmail.com>2009-11-20 14:15:05 +0000
committerYang Tse <yangsita@gmail.com>2009-11-20 14:15:05 +0000
commitc3266a5eb1340f5d7e467ced428a32b68b57a8f7 (patch)
tree24f7bef92bce1d49bf197370516e47244fd9354d /ares/ares_set_socket_callback.3
parentced1e1e7267df300094936b576b19810a6b4f8df (diff)
Sync man page with reality
Diffstat (limited to 'ares/ares_set_socket_callback.3')
-rw-r--r--ares/ares_set_socket_callback.39
1 files changed, 7 insertions, 2 deletions
diff --git a/ares/ares_set_socket_callback.3 b/ares/ares_set_socket_callback.3
index c4f045577..fb598ca29 100644
--- a/ares/ares_set_socket_callback.3
+++ b/ares/ares_set_socket_callback.3
@@ -1,15 +1,20 @@
.\" $Id$
.\"
-.TH ARES_SET_SOCKET_CALLBACK 3 "2 Dec 2008"
+.TH ARES_SET_SOCKET_CALLBACK 3 "20 Nov 2009"
.SH NAME
ares_set_socket_callback \- Set a socket creation callback
.SH SYNOPSIS
.nf
-int ares_set_socket_callback(ares_channel \fIchannel\fP,
+.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