mirror of
https://github.com/isc-projects/bind9.git
synced 2026-07-05 09:25:47 -04:00
291 lines
6.7 KiB
C
291 lines
6.7 KiB
C
/*
|
|
* Copyright (C) 2004, 2006-2009, 2012 Internet Systems Consortium, Inc. ("ISC")
|
|
* Copyright (C) 1998-2001 Internet Software Consortium.
|
|
*
|
|
* Permission to use, copy, modify, and/or distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
|
|
* REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
* AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
|
|
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
* LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
|
|
* OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
/* $Id: time.h,v 1.35 2009/01/05 23:47:54 tbox Exp $ */
|
|
|
|
#ifndef ISC_TIME_H
|
|
#define ISC_TIME_H 1
|
|
|
|
#include <windows.h>
|
|
|
|
#include <isc/lang.h>
|
|
#include <isc/types.h>
|
|
|
|
/***
|
|
*** Intervals
|
|
***/
|
|
|
|
/*
|
|
* The contents of this structure are private, and MUST NOT be accessed
|
|
* directly by callers.
|
|
*
|
|
* The contents are exposed only to allow callers to avoid dynamic allocation.
|
|
*/
|
|
struct isc_interval {
|
|
isc_int64_t interval;
|
|
};
|
|
|
|
LIBISC_EXTERNAL_DATA extern const isc_interval_t * const isc_interval_zero;
|
|
|
|
ISC_LANG_BEGINDECLS
|
|
|
|
void
|
|
isc_interval_set(isc_interval_t *i,
|
|
unsigned int seconds, unsigned int nanoseconds);
|
|
/*
|
|
* Set 'i' to a value representing an interval of 'seconds' seconds and
|
|
* 'nanoseconds' nanoseconds, suitable for use in isc_time_add() and
|
|
* isc_time_subtract().
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't' is a valid pointer.
|
|
* nanoseconds < 1000000000.
|
|
*/
|
|
|
|
isc_boolean_t
|
|
isc_interval_iszero(const isc_interval_t *i);
|
|
/*
|
|
* Returns ISC_TRUE iff. 'i' is the zero interval.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'i' is a valid pointer.
|
|
*/
|
|
|
|
/***
|
|
*** Absolute Times
|
|
***/
|
|
|
|
/*
|
|
* The contents of this structure are private, and MUST NOT be accessed
|
|
* directly by callers.
|
|
*
|
|
* The contents are exposed only to allow callers to avoid dynamic allocation.
|
|
*/
|
|
|
|
struct isc_time {
|
|
FILETIME absolute;
|
|
};
|
|
|
|
LIBISC_EXTERNAL_DATA extern const isc_time_t * const isc_time_epoch;
|
|
|
|
void
|
|
isc_time_set(isc_time_t *t, unsigned int seconds, unsigned int nanoseconds);
|
|
/*%<
|
|
* Set 't' to a value which represents the given number of seconds and
|
|
* nanoseconds since 00:00:00 January 1, 1970, UTC.
|
|
*
|
|
* Requires:
|
|
*\li 't' is a valid pointer.
|
|
*\li nanoseconds < 1000000000.
|
|
*/
|
|
|
|
void
|
|
isc_time_settoepoch(isc_time_t *t);
|
|
/*
|
|
* Set 't' to the time of the epoch.
|
|
*
|
|
* Notes:
|
|
* The date of the epoch is platform-dependent.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't' is a valid pointer.
|
|
*/
|
|
|
|
isc_boolean_t
|
|
isc_time_isepoch(const isc_time_t *t);
|
|
/*
|
|
* Returns ISC_TRUE iff. 't' is the epoch ("time zero").
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't' is a valid pointer.
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_time_now(isc_time_t *t);
|
|
/*
|
|
* Set 't' to the current absolute time.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't' is a valid pointer.
|
|
*
|
|
* Returns:
|
|
*
|
|
* Success
|
|
* Unexpected error
|
|
* Getting the time from the system failed.
|
|
* Out of range
|
|
* The time from the system is too large to be represented
|
|
* in the current definition of isc_time_t.
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_time_nowplusinterval(isc_time_t *t, const isc_interval_t *i);
|
|
/*
|
|
* Set *t to the current absolute time + i.
|
|
*
|
|
* Note:
|
|
* This call is equivalent to:
|
|
*
|
|
* isc_time_now(t);
|
|
* isc_time_add(t, i, t);
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't' and 'i' are valid pointers.
|
|
*
|
|
* Returns:
|
|
*
|
|
* Success
|
|
* Unexpected error
|
|
* Getting the time from the system failed.
|
|
* Out of range
|
|
* The interval added to the time from the system is too large to
|
|
* be represented in the current definition of isc_time_t.
|
|
*/
|
|
|
|
int
|
|
isc_time_compare(const isc_time_t *t1, const isc_time_t *t2);
|
|
/*
|
|
* Compare the times referenced by 't1' and 't2'
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't1' and 't2' are valid pointers.
|
|
*
|
|
* Returns:
|
|
*
|
|
* -1 t1 < t2 (comparing times, not pointers)
|
|
* 0 t1 = t2
|
|
* 1 t1 > t2
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_time_add(const isc_time_t *t, const isc_interval_t *i, isc_time_t *result);
|
|
/*
|
|
* Add 'i' to 't', storing the result in 'result'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't', 'i', and 'result' are valid pointers.
|
|
*
|
|
* Returns:
|
|
* Success
|
|
* Out of range
|
|
* The interval added to the time is too large to
|
|
* be represented in the current definition of isc_time_t.
|
|
*/
|
|
|
|
isc_result_t
|
|
isc_time_subtract(const isc_time_t *t, const isc_interval_t *i,
|
|
isc_time_t *result);
|
|
/*
|
|
* Subtract 'i' from 't', storing the result in 'result'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't', 'i', and 'result' are valid pointers.
|
|
*
|
|
* Returns:
|
|
* Success
|
|
* Out of range
|
|
* The interval is larger than the time since the epoch.
|
|
*/
|
|
|
|
isc_uint64_t
|
|
isc_time_microdiff(const isc_time_t *t1, const isc_time_t *t2);
|
|
/*
|
|
* Find the difference in milliseconds between time t1 and time t2.
|
|
* t2 is the subtrahend of t1; ie, difference = t1 - t2.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 't1' and 't2' are valid pointers.
|
|
*
|
|
* Returns:
|
|
* The difference of t1 - t2, or 0 if t1 <= t2.
|
|
*/
|
|
|
|
isc_uint32_t
|
|
isc_time_nanoseconds(const isc_time_t *t);
|
|
/*
|
|
* Return the number of nanoseconds stored in a time structure.
|
|
*
|
|
* Notes:
|
|
* This is the number of nanoseconds in excess of the number
|
|
* of seconds since the epoch; it will always be less than one
|
|
* full second.
|
|
*
|
|
* Requires:
|
|
* 't' is a valid pointer.
|
|
*
|
|
* Ensures:
|
|
* The returned value is less than 1*10^9.
|
|
*/
|
|
|
|
void
|
|
isc_time_formattimestamp(const isc_time_t *t, char *buf, unsigned int len);
|
|
/*
|
|
* Format the time 't' into the buffer 'buf' of length 'len',
|
|
* using a format like "30-Aug-2000 04:06:47.997" and the local time zone.
|
|
* If the text does not fit in the buffer, the result is indeterminate,
|
|
* but is always guaranteed to be null terminated.
|
|
*
|
|
* Requires:
|
|
* 'len' > 0
|
|
* 'buf' points to an array of at least len chars
|
|
*
|
|
*/
|
|
|
|
void
|
|
isc_time_formathttptimestamp(const isc_time_t *t, char *buf, unsigned int len);
|
|
/*
|
|
* Format the time 't' into the buffer 'buf' of length 'len',
|
|
* using a format like "Mon, 30 Aug 2000 04:06:47 GMT"
|
|
* If the text does not fit in the buffer, the result is indeterminate,
|
|
* but is always guaranteed to be null terminated.
|
|
*
|
|
* Requires:
|
|
* 'len' > 0
|
|
* 'buf' points to an array of at least len chars
|
|
*
|
|
*/
|
|
|
|
void
|
|
isc_time_formatISO8601(const isc_time_t *t, char *buf, unsigned int len);
|
|
/*%<
|
|
* Format the time 't' into the buffer 'buf' of length 'len',
|
|
* using the ISO8601 format: "yyyy-mm-ddThh:mm:ssZ"
|
|
* If the text does not fit in the buffer, the result is indeterminate,
|
|
* but is always guaranteed to be null terminated.
|
|
*
|
|
* Requires:
|
|
*\li 'len' > 0
|
|
*\li 'buf' points to an array of at least len chars
|
|
*
|
|
*/
|
|
|
|
isc_uint32_t
|
|
isc_time_seconds(const isc_time_t *t);
|
|
|
|
ISC_LANG_ENDDECLS
|
|
|
|
#endif /* ISC_TIME_H */
|