1135446Strhodes/*
2193149Sdougb * Copyright (C) 2004-2007  Internet Systems Consortium, Inc. ("ISC")
3135446Strhodes * Copyright (C) 2000, 2001  Internet Software Consortium.
4135446Strhodes *
5193149Sdougb * Permission to use, copy, modify, and/or distribute this software for any
6135446Strhodes * purpose with or without fee is hereby granted, provided that the above
7135446Strhodes * copyright notice and this permission notice appear in all copies.
8135446Strhodes *
9135446Strhodes * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10135446Strhodes * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11135446Strhodes * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12135446Strhodes * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13135446Strhodes * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14135446Strhodes * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15135446Strhodes * PERFORMANCE OF THIS SOFTWARE.
16135446Strhodes */
17135446Strhodes
18234010Sdougb/* $Id: timer.h,v 1.9 2007/06/19 23:47:17 tbox Exp $ */
19135446Strhodes
20135446Strhodes#ifndef DNS_TIMER_H
21135446Strhodes#define DNS_TIMER_H 1
22135446Strhodes
23193149Sdougb/*! \file dns/timer.h */
24170222Sdougb
25135446Strhodes/***
26135446Strhodes ***	Imports
27135446Strhodes ***/
28135446Strhodes
29135446Strhodes#include <isc/buffer.h>
30135446Strhodes#include <isc/lang.h>
31135446Strhodes
32135446StrhodesISC_LANG_BEGINDECLS
33135446Strhodes
34135446Strhodes/***
35135446Strhodes ***	Functions
36135446Strhodes ***/
37135446Strhodes
38135446Strhodesisc_result_t
39135446Strhodesdns_timer_setidle(isc_timer_t *timer, unsigned int maxtime,
40135446Strhodes		  unsigned int idletime, isc_boolean_t purge);
41170222Sdougb/*%<
42135446Strhodes * Convenience function for setting up simple, one-second-granularity
43135446Strhodes * idle timers as used by zone transfers.
44170222Sdougb * \brief
45135446Strhodes * Set the timer 'timer' to go off after 'idletime' seconds of inactivity,
46135446Strhodes * or after 'maxtime' at the very latest.  Events are purged iff
47135446Strhodes * 'purge' is ISC_TRUE.
48135446Strhodes */
49135446Strhodes
50135446StrhodesISC_LANG_ENDDECLS
51135446Strhodes
52135446Strhodes#endif /* DNS_TIMER_H */
53