stdtime.h revision 290001 
1/*
2 * Copyright (C) 2004, 2005, 2007, 2011, 2012  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$ */
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 */
33typedef isc_uint32_t isc_stdtime_t;
34
35/* but this flag helps... */
36#define STDTIME_ON_32BITS	1
37
38/*
39 * isc_stdtime32_t is a 32-bit version of isc_stdtime_t.  A variable of this
40 * type should only be used as an opaque integer (e.g.,) to compare two
41 * time values.
42 */
43typedef isc_uint32_t isc_stdtime32_t;
44
45ISC_LANG_BEGINDECLS
46/* */
47void
48isc_stdtime_get(isc_stdtime_t *t);
49/*%<
50 * Set 't' to the number of seconds since 00:00:00 UTC, January 1, 1970.
51 *
52 * Requires:
53 *
54 *\li	't' is a valid pointer.
55 */
56
57#define isc_stdtime_convert32(t, t32p) (*(t32p) = t)
58/*
59 * Convert the standard time to its 32-bit version.
60 */
61
62ISC_LANG_ENDDECLS
63
64#endif /* ISC_STDTIME_H */
65