| 1 | .\" $Id: ares_timeout.3,v 1.1 1998-08-13 18:07:36 ghudson Exp $ |
|---|
| 2 | .\" |
|---|
| 3 | .\" Copyright 1998 by the Massachusetts Institute of Technology. |
|---|
| 4 | .\" |
|---|
| 5 | .\" Permission to use, copy, modify, and distribute this |
|---|
| 6 | .\" software and its documentation for any purpose and without |
|---|
| 7 | .\" fee is hereby granted, provided that the above copyright |
|---|
| 8 | .\" notice appear in all copies and that both that copyright |
|---|
| 9 | .\" notice and this permission notice appear in supporting |
|---|
| 10 | .\" documentation, and that the name of M.I.T. not be used in |
|---|
| 11 | .\" advertising or publicity pertaining to distribution of the |
|---|
| 12 | .\" software without specific, written prior permission. |
|---|
| 13 | .\" M.I.T. makes no representations about the suitability of |
|---|
| 14 | .\" this software for any purpose. It is provided "as is" |
|---|
| 15 | .\" without express or implied warranty. |
|---|
| 16 | .\" |
|---|
| 17 | .TH ARES_TIMEOUT 3 "25 July 1998" |
|---|
| 18 | .SH NAME |
|---|
| 19 | ares_fds \- Get file descriptors to select on for name service |
|---|
| 20 | .SH SYNOPSIS |
|---|
| 21 | .nf |
|---|
| 22 | .B #include <ares.h> |
|---|
| 23 | .PP |
|---|
| 24 | .B struct timeval *ares_timeout(ares_channel \fIchannel\fP, |
|---|
| 25 | .B struct timeval *\fImaxtv\fP, struct timeval *\fItvbuf\fP) |
|---|
| 26 | .fi |
|---|
| 27 | .SH DESCRIPTION |
|---|
| 28 | The |
|---|
| 29 | .B ares_timeout |
|---|
| 30 | function determines the maximum time for which the caller should wait |
|---|
| 31 | before invoking |
|---|
| 32 | .BR ares_process (3) |
|---|
| 33 | to process timeouts. The parameter |
|---|
| 34 | .I maxtv |
|---|
| 35 | specifies a existing maximum timeout, or |
|---|
| 36 | .B NULL |
|---|
| 37 | if the caller does not wish to apply a maximum timeout. The parameter |
|---|
| 38 | .I tvbuf |
|---|
| 39 | must point to a writable buffer of type |
|---|
| 40 | .BR "struct timeval" . |
|---|
| 41 | It is valid for |
|---|
| 42 | .I maxtv |
|---|
| 43 | and |
|---|
| 44 | .I tvbuf |
|---|
| 45 | to have the same value. |
|---|
| 46 | .PP |
|---|
| 47 | If no queries have timeouts pending sooner than the given maximum |
|---|
| 48 | timeout, |
|---|
| 49 | .B ares_timeout |
|---|
| 50 | returns the value of |
|---|
| 51 | .IR maxtv; |
|---|
| 52 | otherwise |
|---|
| 53 | .B ares_timeout |
|---|
| 54 | stores the appropriate timeout value into the buffer pointed to by |
|---|
| 55 | .I tvbuf |
|---|
| 56 | and returns the value of |
|---|
| 57 | .IR tvbuf . |
|---|
| 58 | .SH SEE ALSO |
|---|
| 59 | .BR ares_fds (3), |
|---|
| 60 | .BR ares_process (3) |
|---|
| 61 | .SH AUTHOR |
|---|
| 62 | Greg Hudson, MIT Information Systems |
|---|
| 63 | .br |
|---|
| 64 | Copyright 1998 by the Massachusetts Institute of Technology. |
|---|
