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