diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2008-12-04 12:54:43 +0000 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2008-12-04 12:54:43 +0000 |
| commit | 9117775d490414e4f5f0dce6ba2926ed44b846e5 (patch) | |
| tree | 30b51ba070e8f00e5187fb12b3c00c90b865e4dd /ares_set_socket_callback.3 | |
| parent | f61fa37f40158cca871fdce5d4a546e8ba3f482a (diff) | |
| download | c-ares-9117775d490414e4f5f0dce6ba2926ed44b846e5.tar.gz c-ares-9117775d490414e4f5f0dce6ba2926ed44b846e5.tar.bz2 c-ares-9117775d490414e4f5f0dce6ba2926ed44b846e5.zip | |
the initial version of the ares_set_socket_callback man page
Diffstat (limited to 'ares_set_socket_callback.3')
| -rw-r--r-- | ares_set_socket_callback.3 | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/ares_set_socket_callback.3 b/ares_set_socket_callback.3 new file mode 100644 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 + |