diff options
Diffstat (limited to 'src/c-ares/ares_set_socket_callback.3')
| -rw-r--r-- | src/c-ares/ares_set_socket_callback.3 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/src/c-ares/ares_set_socket_callback.3 b/src/c-ares/ares_set_socket_callback.3 new file mode 100644 index 00000000..14a5ad2d --- /dev/null +++ b/src/c-ares/ares_set_socket_callback.3 @@ -0,0 +1,32 @@ +.\" +.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 typedef int (*ares_sock_create_callback)(ares_socket_t \fIsocket_fd\fP, + int \fItype\fP, + void *\fIuserdata\fP) +.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 return -1 to signal an error. A returned error will +abort the ares operation. +.SH SEE ALSO +.BR ares_init_options (3), ares_set_socket_configure_callback (3) +.SH AVAILABILITY +ares_set_socket_callback(3) was added in c-ares 1.6.0 +.SH AUTHOR +Gregor Jasny + |