ares_set_socket_callback.3 821 B

123456789101112131415161718192021222324
  1. .\" $Id$
  2. .\"
  3. .TH ARES_SET_SOCKET_CALLBACK 3 "2 Dec 2008"
  4. .SH NAME
  5. ares_set_socket_callback \- Set a socket creation callback
  6. .SH SYNOPSIS
  7. .nf
  8. int ares_set_socket_callback(ares_channel \fIchannel\fP,
  9. ares_sock_create_callback \fIcallback\fP,
  10. void *\fIuserdata\fP)
  11. .fi
  12. .SH DESCRIPTION
  13. This function sets a \fIcallback\fP in the given ares channel handle. This
  14. callback function will be invoked after the socket has been created, and
  15. connected to the remote server. The callback must return ARES_SUCCESS if
  16. things are fine, or use the standard ares error codes to signal errors
  17. back. Returned errors will abort the ares operation.
  18. .SH SEE ALSO
  19. .BR ares_init_options (3)
  20. .SH AVAILABILITY
  21. ares_set_socket_callback(3) was added in c-ares 1.6.0
  22. .SH AUTHOR
  23. Gregor Jasny