summaryrefslogtreecommitdiff
path: root/ares_set_socket_callback.3
diff options
context:
space:
mode:
authorYang Tse <yangsita@gmail.com>2009-11-20 14:15:05 (GMT)
committerYang Tse <yangsita@gmail.com>2009-11-20 14:15:05 (GMT)
commitf854ecb90befef777b6907f76d35276633830be5 (patch)
treeb07cdbaefb62cd06f0d6e134c529098973fe398a /ares_set_socket_callback.3
parent7a7befd37b57ffca6b28fc89c880f2c3d5452e63 (diff)
downloadc-ares-f854ecb90befef777b6907f76d35276633830be5.zip
c-ares-f854ecb90befef777b6907f76d35276633830be5.tar.gz
c-ares-f854ecb90befef777b6907f76d35276633830be5.tar.bz2
Sync man page with reality
Diffstat (limited to 'ares_set_socket_callback.3')
-rw-r--r--ares_set_socket_callback.39
1 files changed, 7 insertions, 2 deletions
diff --git a/ares_set_socket_callback.3 b/ares_set_socket_callback.3
index c4f0455..fb598ca 100644
--- a/ares_set_socket_callback.3
+++ b/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