ares_set_socket_callback(3)

ares_set_socket_callback3

Set a socket creation callback

Usage

#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_t *channel,
                              ares_sock_create_callback callback,
                              void *userdata)

cc file.c -lcares

Overview

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_SUCCESS if things are fine, or return -1 to signal an error. A returned error will abort the ares operation.

The callback is invoked while c-ares is part-way through opening a connection. It must not call any c-ares function on the same channel; see ares_set_socket_functions(3).

Releases

9 releases since Debian 6.0 (Squeeze); the text changed 3 times.

  1. 6.0–8
  2. 9–12
  3. 13
  4. Arch

Availability

ares_set_socket_callback(3) was added in c-ares 1.6.0

From c-ares 1.34.9-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.