/contrib/bind9/lib/dns/include/dns/timer.h

https://bitbucket.org/freebsd/freebsd-head/ · C Header · 52 lines · 10 code · 10 blank · 32 comment · 0 complexity · 7d80d95e9f5f15f81b0730489d10d9db MD5 · raw file

  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. /* $Id: timer.h,v 1.9 2007/06/19 23:47:17 tbox Exp $ */
  18. #ifndef DNS_TIMER_H
  19. #define DNS_TIMER_H 1
  20. /*! \file dns/timer.h */
  21. /***
  22. *** Imports
  23. ***/
  24. #include <isc/buffer.h>
  25. #include <isc/lang.h>
  26. ISC_LANG_BEGINDECLS
  27. /***
  28. *** Functions
  29. ***/
  30. isc_result_t
  31. dns_timer_setidle(isc_timer_t *timer, unsigned int maxtime,
  32. unsigned int idletime, isc_boolean_t purge);
  33. /*%<
  34. * Convenience function for setting up simple, one-second-granularity
  35. * idle timers as used by zone transfers.
  36. * \brief
  37. * Set the timer 'timer' to go off after 'idletime' seconds of inactivity,
  38. * or after 'maxtime' at the very latest. Events are purged iff
  39. * 'purge' is ISC_TRUE.
  40. */
  41. ISC_LANG_ENDDECLS
  42. #endif /* DNS_TIMER_H */