xref: /minix3/external/bsd/bind/dist/lib/dns/include/dns/timer.h (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek /*	$NetBSD: timer.h,v 1.4 2014/12/10 04:37:58 christos Exp $	*/
2*00b67f09SDavid van Moolenbroek 
3*00b67f09SDavid van Moolenbroek /*
4*00b67f09SDavid van Moolenbroek  * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
5*00b67f09SDavid van Moolenbroek  * Copyright (C) 2000, 2001  Internet Software Consortium.
6*00b67f09SDavid van Moolenbroek  *
7*00b67f09SDavid van Moolenbroek  * Permission to use, copy, modify, and/or distribute this software for any
8*00b67f09SDavid van Moolenbroek  * purpose with or without fee is hereby granted, provided that the above
9*00b67f09SDavid van Moolenbroek  * copyright notice and this permission notice appear in all copies.
10*00b67f09SDavid van Moolenbroek  *
11*00b67f09SDavid van Moolenbroek  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12*00b67f09SDavid van Moolenbroek  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13*00b67f09SDavid van Moolenbroek  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14*00b67f09SDavid van Moolenbroek  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15*00b67f09SDavid van Moolenbroek  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16*00b67f09SDavid van Moolenbroek  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*00b67f09SDavid van Moolenbroek  * PERFORMANCE OF THIS SOFTWARE.
18*00b67f09SDavid van Moolenbroek  */
19*00b67f09SDavid van Moolenbroek 
20*00b67f09SDavid van Moolenbroek /* Id: timer.h,v 1.9 2007/06/19 23:47:17 tbox Exp  */
21*00b67f09SDavid van Moolenbroek 
22*00b67f09SDavid van Moolenbroek #ifndef DNS_TIMER_H
23*00b67f09SDavid van Moolenbroek #define DNS_TIMER_H 1
24*00b67f09SDavid van Moolenbroek 
25*00b67f09SDavid van Moolenbroek /*! \file dns/timer.h */
26*00b67f09SDavid van Moolenbroek 
27*00b67f09SDavid van Moolenbroek /***
28*00b67f09SDavid van Moolenbroek  ***	Imports
29*00b67f09SDavid van Moolenbroek  ***/
30*00b67f09SDavid van Moolenbroek 
31*00b67f09SDavid van Moolenbroek #include <isc/buffer.h>
32*00b67f09SDavid van Moolenbroek #include <isc/lang.h>
33*00b67f09SDavid van Moolenbroek 
34*00b67f09SDavid van Moolenbroek ISC_LANG_BEGINDECLS
35*00b67f09SDavid van Moolenbroek 
36*00b67f09SDavid van Moolenbroek /***
37*00b67f09SDavid van Moolenbroek  ***	Functions
38*00b67f09SDavid van Moolenbroek  ***/
39*00b67f09SDavid van Moolenbroek 
40*00b67f09SDavid van Moolenbroek isc_result_t
41*00b67f09SDavid van Moolenbroek dns_timer_setidle(isc_timer_t *timer, unsigned int maxtime,
42*00b67f09SDavid van Moolenbroek 		  unsigned int idletime, isc_boolean_t purge);
43*00b67f09SDavid van Moolenbroek /*%<
44*00b67f09SDavid van Moolenbroek  * Convenience function for setting up simple, one-second-granularity
45*00b67f09SDavid van Moolenbroek  * idle timers as used by zone transfers.
46*00b67f09SDavid van Moolenbroek  * \brief
47*00b67f09SDavid van Moolenbroek  * Set the timer 'timer' to go off after 'idletime' seconds of inactivity,
48*00b67f09SDavid van Moolenbroek  * or after 'maxtime' at the very latest.  Events are purged iff
49*00b67f09SDavid van Moolenbroek  * 'purge' is ISC_TRUE.
50*00b67f09SDavid van Moolenbroek  */
51*00b67f09SDavid van Moolenbroek 
52*00b67f09SDavid van Moolenbroek ISC_LANG_ENDDECLS
53*00b67f09SDavid van Moolenbroek 
54*00b67f09SDavid van Moolenbroek #endif /* DNS_TIMER_H */
55