Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
aes.h	1015 B	-rw-r--r--	2021-11-05 09:03
align.h	569 B	-rw-r--r--	2021-11-05 09:03
app.h	6.97 KB	-rw-r--r--	2021-11-05 09:03
assertions.h	2.17 KB	-rw-r--r--	2021-11-05 09:03
astack.h	1.11 KB	-rw-r--r--	2021-11-05 09:03
atomic.h	3.01 KB	-rw-r--r--	2021-11-05 09:03
backtrace.h	3.8 KB	-rw-r--r--	2021-11-05 09:03
barrier.h	1.03 KB	-rw-r--r--	2021-11-05 09:03
base32.h	4.35 KB	-rw-r--r--	2021-11-05 09:03
base64.h	2.8 KB	-rw-r--r--	2021-11-05 09:03
bind9.h	829 B	-rw-r--r--	2021-11-05 09:03
buffer.h	29.91 KB	-rw-r--r--	2021-11-05 09:03
bufferlist.h	1.42 KB	-rw-r--r--	2021-11-05 09:03
cmocka.h	1.35 KB	-rw-r--r--	2021-11-05 09:03
commandline.h	1.67 KB	-rw-r--r--	2021-11-05 09:03
condition.h	1.87 KB	-rw-r--r--	2021-11-05 09:03
counter.h	1.88 KB	-rw-r--r--	2021-11-05 09:03
crc64.h	998 B	-rw-r--r--	2021-11-05 09:03
deprecated.h	662 B	-rw-r--r--	2021-11-05 09:03
dir.h	1.51 KB	-rw-r--r--	2021-11-05 09:03
endian.h	4.75 KB	-rw-r--r--	2021-11-05 09:03
errno.h	659 B	-rw-r--r--	2021-11-05 09:03
errno2result.h	901 B	-rw-r--r--	2025-07-29 21:44
error.h	1.4 KB	-rw-r--r--	2021-11-05 09:03
event.h	3.36 KB	-rw-r--r--	2021-11-05 09:03
eventclass.h	1.41 KB	-rw-r--r--	2021-11-05 09:03
file.h	11.4 KB	-rw-r--r--	2021-11-05 09:03
formatcheck.h	940 B	-rw-r--r--	2021-11-05 09:03
fsaccess.h	7.28 KB	-rw-r--r--	2021-11-05 09:03
fuzz.h	593 B	-rw-r--r--	2021-11-05 09:03
hash.h	1.61 KB	-rw-r--r--	2021-11-05 09:03
heap.h	5.14 KB	-rw-r--r--	2021-11-05 09:03
hex.h	2.74 KB	-rw-r--r--	2021-11-05 09:03
hmac.h	3.88 KB	-rw-r--r--	2021-11-05 09:03
hp.h	4.48 KB	-rw-r--r--	2021-11-05 09:03
ht.h	4.38 KB	-rw-r--r--	2025-07-29 21:41
httpd.h	2.24 KB	-rw-r--r--	2021-11-05 09:03
interfaceiter.h	3.07 KB	-rw-r--r--	2021-11-05 09:03
iterated_hash.h	933 B	-rw-r--r--	2021-11-05 09:03
lang.h	686 B	-rw-r--r--	2021-11-05 09:03
lex.h	9.77 KB	-rw-r--r--	2021-11-05 09:03
lfsr.h	2.89 KB	-rw-r--r--	2021-11-05 09:03
lib.h	1.13 KB	-rw-r--r--	2021-11-05 09:03
likely.h	868 B	-rw-r--r--	2021-11-05 09:03
list.h	7.9 KB	-rw-r--r--	2021-11-05 09:03
log.h	25.88 KB	-rw-r--r--	2021-11-05 09:03
magic.h	999 B	-rw-r--r--	2021-11-05 09:03
managers.h	776 B	-rw-r--r--	2021-11-05 09:03
md.h	5.63 KB	-rw-r--r--	2021-11-05 09:03
mem.h	17.66 KB	-rw-r--r--	2021-11-05 09:03
meminfo.h	710 B	-rw-r--r--	2021-11-05 09:03
mutex.h	4.08 KB	-rw-r--r--	2021-11-05 09:03
mutexatomic.h	9.56 KB	-rw-r--r--	2021-11-05 09:03
mutexblock.h	1.13 KB	-rw-r--r--	2021-11-05 09:03
net.h	8.36 KB	-rw-r--r--	2021-11-05 09:03
netaddr.h	4.67 KB	-rw-r--r--	2021-11-05 09:03
netdb.h	860 B	-rw-r--r--	2021-11-05 09:03
netmgr.h	15.36 KB	-rw-r--r--	2025-07-29 21:41
netscope.h	966 B	-rw-r--r--	2021-11-05 09:03
nonce.h	743 B	-rw-r--r--	2021-11-05 09:03
offset.h	687 B	-rw-r--r--	2021-11-05 09:03
once.h	767 B	-rw-r--r--	2021-11-05 09:03
os.h	670 B	-rw-r--r--	2021-11-05 09:03
parseint.h	1.5 KB	-rw-r--r--	2021-11-05 09:03
platform.h	1.82 KB	-rw-r--r--	2025-07-29 21:41
pool.h	3.41 KB	-rw-r--r--	2021-11-05 09:03
portset.h	3.22 KB	-rw-r--r--	2021-11-05 09:03
print.h	680 B	-rw-r--r--	2021-11-05 09:03
queue.h	1.31 KB	-rw-r--r--	2021-11-05 09:03
quota.h	3.48 KB	-rw-r--r--	2021-11-05 09:03
radix.h	6.85 KB	-rw-r--r--	2021-11-05 09:03
random.h	1.45 KB	-rw-r--r--	2021-11-05 09:03
ratelimiter.h	3.41 KB	-rw-r--r--	2021-11-05 09:03
refcount.h	4.98 KB	-rw-r--r--	2021-11-05 09:03
regex.h	767 B	-rw-r--r--	2021-11-05 09:03
region.h	2.18 KB	-rw-r--r--	2021-11-05 09:03
resource.h	2.79 KB	-rw-r--r--	2021-11-05 09:03
result.h	5.45 KB	-rw-r--r--	2021-11-05 09:03
resultclass.h	1.56 KB	-rw-r--r--	2021-11-05 09:03
rwlock.h	2.48 KB	-rw-r--r--	2021-11-05 09:03
safe.h	1.12 KB	-rw-r--r--	2021-11-05 09:03
serial.h	1.33 KB	-rw-r--r--	2021-11-05 09:03
siphash.h	916 B	-rw-r--r--	2021-11-05 09:03
sockaddr.h	6.13 KB	-rw-r--r--	2021-11-05 09:03
socket.h	23.55 KB	-rw-r--r--	2021-11-05 09:03
stat.h	803 B	-rw-r--r--	2021-11-05 09:03
stats.h	6.53 KB	-rw-r--r--	2021-11-05 09:03
stdatomic.h	8.9 KB	-rw-r--r--	2021-11-05 09:03
stdio.h	1.69 KB	-rw-r--r--	2021-11-05 09:03
stdtime.h	1.36 KB	-rw-r--r--	2021-11-05 09:03
strerr.h	575 B	-rw-r--r--	2021-11-05 09:03
string.h	851 B	-rw-r--r--	2021-11-05 09:03
symtab.h	4.22 KB	-rw-r--r--	2021-11-05 09:03
syslog.h	843 B	-rw-r--r--	2021-11-05 09:03
task.h	16.72 KB	-rw-r--r--	2021-11-05 09:03
taskpool.h	3.2 KB	-rw-r--r--	2021-11-05 09:03
thread.h	1.86 KB	-rw-r--r--	2021-11-05 09:03
time.h	10.85 KB	-rw-r--r--	2021-11-05 09:03
timer.h	7.77 KB	-rw-r--r--	2021-11-05 09:03
tm.h	894 B	-rw-r--r--	2021-11-05 09:03
types.h	5.72 KB	-rw-r--r--	2021-11-05 09:03
url.h	2.62 KB	-rw-r--r--	2021-11-05 09:03
utf8.h	928 B	-rw-r--r--	2021-11-05 09:03
util.h	13.96 KB	-rw-r--r--	2021-11-05 09:03
version.h	499 B	-rw-r--r--	2021-11-05 09:03

Rename

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#ifndef ISC_TIME_H
#define ISC_TIME_H 1

/*! \file */

#include <inttypes.h>
#include <stdbool.h>

#include <isc/lang.h>
#include <isc/types.h>

/***
 *** Intervals
 ***/

/*!
 *  \brief
 * 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 {
	unsigned int seconds;
	unsigned int nanoseconds;
};

extern const isc_interval_t *const isc_interval_zero;

/*
 * ISC_FORMATHTTPTIMESTAMP_SIZE needs to be 30 in C locale and potentially
 * more for other locales to handle longer national abbreviations when
 * expanding strftime's %a and %b.
 */
#define ISC_FORMATHTTPTIMESTAMP_SIZE 50

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:
 *
 *\li	't' is a valid pointer.
 *\li	nanoseconds < 1000000000.
 */

bool
isc_interval_iszero(const isc_interval_t *i);
/*%<
 * Returns true iff. 'i' is the zero interval.
 *
 * Requires:
 *
 *\li	'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 {
	unsigned int seconds;
	unsigned int nanoseconds;
};

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.
 *
 * Notes:
 *\li	The Unix version of this call is equivalent to:
 *\code
 *	isc_time_settoepoch(t);
 *	isc_interval_set(i, seconds, nanoseconds);
 *	isc_time_add(t, i, t);
 *\endcode
 *
 * 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:
 *\li	The date of the epoch is platform-dependent.
 *
 * Requires:
 *
 *\li	't' is a valid pointer.
 */

bool
isc_time_isepoch(const isc_time_t *t);
/*%<
 * Returns true iff. 't' is the epoch ("time zero").
 *
 * Requires:
 *
 *\li	't' is a valid pointer.
 */

isc_result_t
isc_time_now(isc_time_t *t);
/*%<
 * Set 't' to the current absolute time.
 *
 * Requires:
 *
 *\li	't' is a valid pointer.
 *
 * Returns:
 *
 *\li	Success
 *\li	Unexpected error
 *		Getting the time from the system failed.
 *\li	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_now_hires(isc_time_t *t);
/*%<
 * Set 't' to the current absolute time. Uses higher resolution clocks
 * recommended when microsecond accuracy is required.
 *
 * Requires:
 *
 *\li	't' is a valid pointer.
 *
 * Returns:
 *
 *\li	Success
 *\li	Unexpected error
 *		Getting the time from the system failed.
 *\li	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:
 *\li	This call is equivalent to:
 *
 *\code
 *		isc_time_now(t);
 *		isc_time_add(t, i, t);
 *\endcode
 *
 * Requires:
 *
 *\li	't' and 'i' are valid pointers.
 *
 * Returns:
 *
 *\li	Success
 *\li	Unexpected error
 *		Getting the time from the system failed.
 *\li	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:
 *
 *\li	't1' and 't2' are valid pointers.
 *
 * Returns:
 *
 *\li	-1		t1 < t2		(comparing times, not pointers)
 *\li	0		t1 = t2
 *\li	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:
 *
 *\li	't', 'i', and 'result' are valid pointers.
 *
 * Returns:
 *\li	Success
 *\li	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:
 *
 *\li	't', 'i', and 'result' are valid pointers.
 *
 * Returns:
 *\li	Success
 *\li	Out of range
 *		The interval is larger than the time since the epoch.
 */

uint64_t
isc_time_microdiff(const isc_time_t *t1, const isc_time_t *t2);
/*%<
 * Find the difference in microseconds between time t1 and time t2.
 * t2 is the subtrahend of t1; ie, difference = t1 - t2.
 *
 * Requires:
 *
 *\li	't1' and 't2' are valid pointers.
 *
 * Returns:
 *\li	The difference of t1 - t2, or 0 if t1 <= t2.
 */

uint32_t
isc_time_seconds(const isc_time_t *t);
/*%<
 * Return the number of seconds since the epoch stored in a time structure.
 *
 * Requires:
 *
 *\li	't' is a valid pointer.
 */

isc_result_t
isc_time_secondsastimet(const isc_time_t *t, time_t *secondsp);
/*%<
 * Ensure the number of seconds in an isc_time_t is representable by a time_t.
 *
 * Notes:
 *\li	The number of seconds stored in an isc_time_t might be larger
 *	than the number of seconds a time_t is able to handle.  Since
 *	time_t is mostly opaque according to the ANSI/ISO standard
 *	(essentially, all you can be sure of is that it is an arithmetic type,
 *	not even necessarily integral), it can be tricky to ensure that
 *	the isc_time_t is in the range a time_t can handle.  Use this
 *	function in place of isc_time_seconds() any time you need to set a
 *	time_t from an isc_time_t.
 *
 * Requires:
 *\li	't' is a valid pointer.
 *
 * Returns:
 *\li	Success
 *\li	Out of range
 */

uint32_t
isc_time_nanoseconds(const isc_time_t *t);
/*%<
 * Return the number of nanoseconds stored in a time structure.
 *
 * Notes:
 *\li	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:
 *\li	't' is a valid pointer.
 *
 * Ensures:
 *\li	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:
 *\li      'len' > 0
 *\li      '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:
 *\li      'len' > 0
 *\li      'buf' points to an array of at least len chars
 *
 */

isc_result_t
isc_time_parsehttptimestamp(char *input, isc_time_t *t);
/*%<
 * Parse the time in 'input' into the isc_time_t pointed to by 't',
 * expecting a format like "Mon, 30 Aug 2000 04:06:47 GMT"
 *
 *  Requires:
 *\li      'buf' and 't' are not NULL.
 */

void
isc_time_formatISO8601L(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:ss"
 * 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
 *
 */

void
isc_time_formatISO8601Lms(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:ss.sss"
 * 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
 *
 */

void
isc_time_formatISO8601Lus(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:ss.ssssss"
 * 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
 *
 */

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
 *
 */

void
isc_time_formatISO8601ms(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:ss.sssZ"
 * 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
 *
 */

void
isc_time_formatISO8601us(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:ss.ssssssZ"
 * 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
 *
 */

void
isc_time_formatshorttimestamp(const isc_time_t *t, char *buf, unsigned int len);
/*%<
 * Format the time 't' into the buffer 'buf' of length 'len',
 * using the format "yyyymmddhhmmsssss" useful for file timestamping.
 * 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_LANG_ENDDECLS

#endif /* ISC_TIME_H */