mirror of https://github.com/c-ares/c-ares.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.2 KiB
45 lines
1.2 KiB
10 months ago
|
.\"
|
||
|
|
.\" SPDX-License-Identifier: MIT
|
||
|
|
.\"
|
||
|
|
.TH ARES_QUEUE_WAIT_EMPTY 3 "12 February 2024"
|
||
|
|
.SH NAME
|
||
|
|
ares_queue_wait_empty \- Wait until all queries are complete for channel
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <ares.h>
|
||
|
|
|
||
|
|
ares_status_t ares_queue_wait_empty(ares_channel_t *channel,
|
||
|
|
int timeout_ms);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
The \fBares_queue_wait_empty(3)\fP function blocks until notified that there are
|
||
|
|
no longer any queries in queue, or the specified timeout has expired.
|
||
|
|
|
||
|
|
The \fBchannel\fP parameter must be set to an initialized channel.
|
||
|
|
|
||
|
|
The \fBtimeout_ms\fP parameter is the number of milliseconds to wait for the
|
||
|
|
queue to be empty or -1 for Infinite.
|
||
|
|
|
||
|
|
.SH RETURN VALUES
|
||
|
|
\fIares_queue_wait_empty(3)\fP can return any of the following values:
|
||
|
|
.TP 14
|
||
|
|
.B ARES_ENOTIMP
|
||
|
|
if not built with threading support
|
||
|
|
.TP 14
|
||
|
|
.B ARES_ETIMEOUT
|
||
|
|
if requested timeout expired
|
||
|
|
.TP 14
|
||
|
|
.B ARES_SUCCESS
|
||
|
|
when queue is empty.
|
||
|
|
.TP 14
|
||
|
|
|
||
|
|
.SH 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.
|
||
|
|
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR ares_init_options (3),
|
||
|
|
.BR ares_threadsafety (3)
|
||
|
|
.SH AUTHOR
|
||
|
|
Copyright (C) 2024 The c-ares project and its members.
|