ceph/src/c-ares/ares_set_socket_configure_callback.3

   1 .\"
   2 .TH ARES_SET_SOCKET_CONFIGURE_CALLBACK 3 "6 Feb 2016"
   3 .SH NAME
   4 ares_set_socket_configure_callback \- Set a socket configuration callback
   5 .SH SYNOPSIS
   6 .nf
   7 .B #include <ares.h>
   8 .PP
   9 .B typedef int (*ares_sock_config_callback)(ares_socket_t \fIsocket_fd\fP,
  10                                          int \fItype\fP,
  11                                          void *\fIuserdata\fP)
  12 .PP
  13 .B void ares_set_socket_configure_callback(ares_channel \fIchannel\fP,
  14                              ares_sock_config_callback \fIcallback\fP,
  15                              void *\fIuserdata\fP)
  16 .PP
  17 .B cc file.c -lcares
  18 .fi
  19 .SH DESCRIPTION
  20 .PP
  21 This function sets a \fIcallback\fP in the given ares channel handle. This
  22 callback function will be invoked after the socket has been created, but
  23 before it has been connected to the remote server, which is an ideal time
  24 to configure various socket options.  The callback must return ARES_SUCCESS
  25 if things are fine, or return -1 to signal an error. A returned error will
  26 abort the ares operation.
  27 .SH SEE ALSO
  28 .BR ares_init_options (3), ares_set_socket_callback (3)
  29 .SH AVAILABILITY
  30 ares_set_socket_configure_callback(3) was added in c-ares 1.11.0
  31 .SH AUTHOR
  32 Andrew Ayer
  33