mirror of
https://github.com/nodejs/node.git
synced 2025-08-16 22:28:51 +02:00
41d90aaf62
PR-URL: https://github.com/nodejs/node/pull/53155 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
31 lines
1.2 KiB
Groff
31 lines
1.2 KiB
Groff
.\"
|
|
.\" Copyright 1998 by the Massachusetts Institute of Technology.
|
|
.\" SPDX-License-Identifier: MIT
|
|
.\"
|
|
.TH ARES_TIMEOUT 3 "25 July 1998"
|
|
.SH NAME
|
|
ares_timeout \- return maximum time to wait
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <ares.h>
|
|
|
|
struct timeval *ares_timeout(const ares_channel_t *\fIchannel\fP,
|
|
struct timeval *\fImaxtv\fP,
|
|
struct timeval *\fItv\fP)
|
|
.fi
|
|
.SH DESCRIPTION
|
|
The \fBares_timeout(3)\fP function determines the maximum time for which the
|
|
caller should wait before invoking \fIares_process(3)\fP to process timeouts.
|
|
The parameter \fImaxtv\fP specifies a existing maximum timeout, or \fBNULL\fP
|
|
if the caller does not wish to apply a maximum timeout. The parameter
|
|
\fItv\fP must point to a writable buffer of type \fBstruct timeval\fP It is
|
|
valid for \fImaxtv\fP and \fItv\fP to have the same value.
|
|
|
|
If no queries have timeouts pending sooner than the given maximum timeout,
|
|
\fBares_timeout(3)\fP returns the value of \fImaxtv\fP; otherwise
|
|
\fBares_timeout(3)\fP stores the appropriate timeout value into the buffer
|
|
pointed to by \fItv\fP and returns the value of \fItv\fP.
|
|
.SH SEE ALSO
|
|
.BR ares_fds (3),
|
|
.BR ares_process (3),
|
|
.BR ares_process_fd (3)
|