ARES_SET_SOCKET_CONFIGURE_CALLBACK

Section: C Library Functions (3)
Updated: 6 Feb 2016
Index Return to Main Contents

---

 

NAME

ares_set_socket_configure_callback - Set a socket configuration callback  

SYNOPSIS

#include <ares.h>

typedef int (*ares_sock_config_callback)(ares_socket_t socket_fd,
                                         int type,
                                         void *userdata)

void ares_set_socket_configure_callback(ares_channel_t *channel,
                                        ares_sock_config_callback callback,
                                        void *userdata)

 

DESCRIPTION

This function sets a callback in the given ares channel handle. Cannot be used when ARES_OPT_EVENT_THREAD is passed to ares_init_options(3).

This callback function will be invoked after the socket has been created, but before it has been connected to the remote server, which is an ideal time to configure various socket options. 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.  

SEE ALSO

ares_init_options(3), ares_set_socket_callback(3)  

AVAILABILITY

ares_set_socket_configure_callback(3) was added in -ares 1.11.0

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO

AVAILABILITY