Mercurial > repos > rliterman > csp2
annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/ares_timeout.3 @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
| author | jpayne |
|---|---|
| date | Tue, 18 Mar 2025 16:23:26 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| jpayne@68 | 1 .\" |
| jpayne@68 | 2 .\" Copyright 1998 by the Massachusetts Institute of Technology. |
| jpayne@68 | 3 .\" SPDX-License-Identifier: MIT |
| jpayne@68 | 4 .\" |
| jpayne@68 | 5 .TH ARES_TIMEOUT 3 "25 July 1998" |
| jpayne@68 | 6 .SH NAME |
| jpayne@68 | 7 ares_timeout \- return maximum time to wait |
| jpayne@68 | 8 .SH SYNOPSIS |
| jpayne@68 | 9 .nf |
| jpayne@68 | 10 #include <ares.h> |
| jpayne@68 | 11 |
| jpayne@68 | 12 struct timeval *ares_timeout(const ares_channel_t *\fIchannel\fP, |
| jpayne@68 | 13 struct timeval *\fImaxtv\fP, |
| jpayne@68 | 14 struct timeval *\fItv\fP) |
| jpayne@68 | 15 .fi |
| jpayne@68 | 16 .SH DESCRIPTION |
| jpayne@68 | 17 The \fBares_timeout(3)\fP function determines the maximum time for which the |
| jpayne@68 | 18 caller should wait before invoking \fIares_process(3)\fP to process timeouts. |
| jpayne@68 | 19 The parameter \fImaxtv\fP specifies a existing maximum timeout, or \fBNULL\fP |
| jpayne@68 | 20 if the caller does not wish to apply a maximum timeout. The parameter |
| jpayne@68 | 21 \fItv\fP must point to a writable buffer of type \fBstruct timeval\fP It is |
| jpayne@68 | 22 valid for \fImaxtv\fP and \fItv\fP to have the same value. |
| jpayne@68 | 23 |
| jpayne@68 | 24 If no queries have timeouts pending sooner than the given maximum timeout, |
| jpayne@68 | 25 \fBares_timeout(3)\fP returns the value of \fImaxtv\fP; otherwise |
| jpayne@68 | 26 \fBares_timeout(3)\fP stores the appropriate timeout value into the buffer |
| jpayne@68 | 27 pointed to by \fItv\fP and returns the value of \fItv\fP. |
| jpayne@68 | 28 .SH SEE ALSO |
| jpayne@68 | 29 .BR ares_fds (3), |
| jpayne@68 | 30 .BR ares_process (3), |
| jpayne@68 | 31 .BR ares_process_fd (3) |