/[resiprocate]/main/contrib/ares/ares_timeout.3
ViewVC logotype

Contents of /main/contrib/ares/ares_timeout.3

Parent Directory Parent Directory | Revision Log Revision Log


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

webmaster AT resiprocate DOT org
ViewVC Help
Powered by ViewVC 1.1.27