Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ares_set_socket_callback (3)

Name

ares_set_socket_callback - Set a socket creation callback

Synopsis

#include <ares.h>

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

void ares_set_socket_callback(ares_channel channel,
ares_sock_create_callback callback,
void *userdata)

cc file.c -lcares

Description

Library Functions Manual                           ARES_SET_SOCKET_CALLBACK(3)



NAME
       ares_set_socket_callback - Set a socket creation callback

SYNOPSIS
       #include <ares.h>

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

       void ares_set_socket_callback(ares_channel channel,
                                    ares_sock_create_callback callback,
                                    void *userdata)

       cc file.c -lcares

DESCRIPTION
       This  function  sets  a callback 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_SUC-
       CESS if things are fine, or return -1 to signal an  error.  A  returned
       error will abort the ares operation.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libcares |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+

SEE ALSO
       ares_init_options(3),ares_set_socket_configure_callback(3)

AVAILABILITY
       ares_set_socket_callback(3) was added in c-ares 1.6.0

AUTHOR
       Gregor Jasny




NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://c-ares.haxx.se/download/c-
       ares-1.17.2.tar.gz.

       Further information about this software can be found on the open source
       community website at https://c-ares.haxx.se/.



                                  20 Nov 2009
                                                   ARES_SET_SOCKET_CALLBACK(3)