contrib/bind-9.3/lib/dns/include/dns/timer.h

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 2000, 2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and 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.2.206.1 2004/03/06 08:14:00 marka Exp $ */
  19
  20 #ifndef DNS_TIMER_H
  21 #define DNS_TIMER_H 1
  22
  23 /***
  24  ***    Imports
  25  ***/
  26
  27 #include <isc/buffer.h>
  28 #include <isc/lang.h>
  29
  30 ISC_LANG_BEGINDECLS
  31
  32 /***
  33  ***    Functions
  34  ***/
  35
  36 isc_result_t
  37 dns_timer_setidle(isc_timer_t *timer, unsigned int maxtime,
  38                   unsigned int idletime, isc_boolean_t purge);
  39 /*
  40  * Convenience function for setting up simple, one-second-granularity
  41  * idle timers as used by zone transfers.
  42  *
  43  * Set the timer 'timer' to go off after 'idletime' seconds of inactivity,
  44  * or after 'maxtime' at the very latest.  Events are purged iff
  45  * 'purge' is ISC_TRUE.
  46  */
  47
  48 ISC_LANG_ENDDECLS
  49
  50 #endif /* DNS_TIMER_H */