contrib/bind/lib/isc/unix/include/isc/stdtime.h

   1 /*
   2  * Copyright (C) 2004, 2005, 2007  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-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: stdtime.h,v 1.14 2007/06/19 23:47:19 tbox Exp $ */
  19
  20 #ifndef ISC_STDTIME_H
  21 #define ISC_STDTIME_H 1
  22
  23 /*! \file */
  24
  25 #include <isc/lang.h>
  26 #include <isc/int.h>
  27
  28 /*%
  29  * It's public information that 'isc_stdtime_t' is an unsigned integral type.
  30  * Applications that want maximum portability should not assume anything
  31  * about its size.
  32  */
  33 typedef isc_uint32_t isc_stdtime_t;
  34 /*
  35  * isc_stdtime32_t is a 32-bit version of isc_stdtime_t.  A variable of this
  36  * type should only be used as an opaque integer (e.g.,) to compare two
  37  * time values.
  38  */
  39 typedef isc_uint32_t isc_stdtime32_t;
  40
  41 ISC_LANG_BEGINDECLS
  42 /* */
  43 void
  44 isc_stdtime_get(isc_stdtime_t *t);
  45 /*%<
  46  * Set 't' to the number of seconds since 00:00:00 UTC, January 1, 1970.
  47  *
  48  * Requires:
  49  *
  50  *\li   't' is a valid pointer.
  51  */
  52
  53 #define isc_stdtime_convert32(t, t32p) (*(t32p) = t)
  54 /*
  55  * Convert the standard time to its 32-bit version.
  56  */
  57
  58 ISC_LANG_ENDDECLS
  59
  60 #endif /* ISC_STDTIME_H */