00001 /* 00002 * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC") 00003 * Copyright (C) 2000, 2001 Internet Software Consortium. 00004 * 00005 * Permission to use, copy, modify, and/or distribute this software for any 00006 * purpose with or without fee is hereby granted, provided that the above 00007 * copyright notice and this permission notice appear in all copies. 00008 * 00009 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 00010 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 00011 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 00012 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 00013 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 00014 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 00015 * PERFORMANCE OF THIS SOFTWARE. 00016 */ 00017 00018 /* $Id: timer.h,v 1.9 2007/06/19 23:47:17 tbox Exp $ */ 00019 00020 #ifndef DNS_TIMER_H 00021 #define DNS_TIMER_H 1 00022 00023 /*! \file dns/timer.h */ 00024 00025 /*** 00026 *** Imports 00027 ***/ 00028 00029 #include <isc/buffer.h> 00030 #include <isc/lang.h> 00031 00032 ISC_LANG_BEGINDECLS 00033 00034 /*** 00035 *** Functions 00036 ***/ 00037 00038 isc_result_t 00039 dns_timer_setidle(isc_timer_t *timer, unsigned int maxtime, 00040 unsigned int idletime, isc_boolean_t purge); 00041 /*%< 00042 * Convenience function for setting up simple, one-second-granularity 00043 * idle timers as used by zone transfers. 00044 * \brief 00045 * Set the timer 'timer' to go off after 'idletime' seconds of inactivity, 00046 * or after 'maxtime' at the very latest. Events are purged iff 00047 * 'purge' is ISC_TRUE. 00048 */ 00049 00050 ISC_LANG_ENDDECLS 00051 00052 #endif /* DNS_TIMER_H */