ares_queue_wait_empty

Name

ares_queue_wait_empty, ares_queue_active_queries - Functions for checking the c-ares queue status

Synopsis

#include <ares.h>
 
size_t ares_queue_active_queries(ares_channel_t *channel);
 
ares_status_t ares_queue_wait_empty(ares_channel_t *channel,
                                    int timeout_ms);

Description

The ares_queue_active_queries function retrieves the total number of active queries pending answers from servers. Some c-ares requests may spawn multiple queries, such as ares_getaddrinfo when using AF_UNSPEC, which will be reflected in this number. The channel parameter must be set to an initialized channel.

The ares_queue_wait_empty function blocks until notified that there are no longer any queries in queue, or the specified timeout has expired. The channel parameter must be set to an initialized channel. The timeout_ms parameter is the number of milliseconds to wait for the queue to be empty or -1 for Infinite.

Return values

ares_queue_active_queries returns the active query count.

ares_queue_wait_empty can return any of the following values:

ARES_ENOTIMP if not built with threading support

ARES_ETIMEOUT if requested timeout expired

ARES_SUCCESS when queue is empty.

Availability

This function was first introduced in c-ares version 1.27.0, and requires the c-ares library to be built with threading support.

See also

ares_init_options(3), ares_threadsafety(3)

Author

Copyright (C) 2024 The c-ares project and its members.

This HTML page was made with roffit.