time.h File Reference

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

Go to the source code of this file.

Data Structures

struct isc_interval

The contents of this structure are private, and MUST NOT be accessed directly by callers. More...

struct isc_time

The contents of this structure are private, and MUST NOT be accessed directly by callers. More...

Defines

#define ISC_TIME_H 1

#define ISC_FORMATHTTPTIMESTAMP_SIZE 50

Functions

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().

isc_boolean_t isc_interval_iszero (const isc_interval_t *i)

Returns ISC_TRUE iff. 'i' is the zero interval.

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.

void isc_time_settoepoch (isc_time_t *t)

Set 't' to the time of the epoch.

isc_boolean_t isc_time_isepoch (const isc_time_t *t)

Returns ISC_TRUE iff. 't' is the epoch ("time zero").

isc_result_t isc_time_now (isc_time_t *t)

Set 't' to the current absolute time.

isc_result_t isc_time_nowplusinterval (isc_time_t *t, const isc_interval_t *i)

Set *t to the current absolute time + i.

int isc_time_compare (const isc_time_t *t1, const isc_time_t *t2)

Compare the times referenced by 't1' and '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'.

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'.

isc_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.

isc_uint32_t isc_time_seconds (const isc_time_t *t)

Return the number of seconds since the epoch stored in a time structure.

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.

isc_uint32_t isc_time_nanoseconds (const isc_time_t *t)

Return the number of nanoseconds stored in a time structure.

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.

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.

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".

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.

Variables

const isc_interval_t *const isc_interval_zero

const isc_time_t *const isc_time_epoch

Detailed Description

Definition in file time.h.

Define Documentation

#define ISC_TIME_H 1

Definition at line 21 of file time.h.

#define ISC_FORMATHTTPTIMESTAMP_SIZE 50

Definition at line 51 of file time.h.

Referenced by ATF_TC_BODY(), dns_ntatable_totext(), isc_httpd_recvdone(), mkey_dumpzone(), mkey_status(), ns_server_status(), ns_server_zonestatus(), and totext_keydata().

Function Documentation

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.

Definition at line 89 of file time.c.

References isc_interval::nanoseconds, NS_PER_S, REQUIRE, and isc_interval::seconds.

Referenced by bringup_timer(), dns_acache_setcleaninginterval(), dns_cache_setcleaninginterval(), dns_timer_setidle(), dns_zone_refresh(), fctx_create(), fctx_getaddresses(), fctx_sendevents(), fctx_setretryinterval(), isc_log_doit(), isc_ratelimiter_create(), load_configuration(), newconnection(), ns_client_error(), ns_client_send(), ns_client_settimeout(), recv_done(), resquery_connected(), schedule(), set_timer(), setmodtime(), setrl(), settimer(), stub_callback(), zone_nsec3chain(), zone_resigninc(), and zone_sign().

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.

Definition at line 100 of file time.c.

References INSIST, ISC_FALSE, ISC_TRUE, isc_interval::nanoseconds, NS_PER_S, REQUIRE, and isc_interval::seconds.

Referenced by isc__timer_create(), and isc__timer_reset().

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:

The Unix version of this call is equivalent to:

        isc_time_settoepoch(t);
        isc_interval_set(i, seconds, nanoseconds);
        isc_time_add(t, i, t);
 *

Requires:

't' is a valid pointer.
nanoseconds < 1000000000.

Definition at line 119 of file time.c.

References isc_time::nanoseconds, NS_PER_S, REQUIRE, and isc_time::seconds.

Referenced by client_request(), dns_ntatable_totext(), isc_file_getmodtime(), isc_time_parsehttptimestamp(), mkey_dumpzone(), ns_server_nta(), ns_server_zonestatus(), set_key_expiry_warning(), set_resigntime(), and totext_keydata().

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.

Definition at line 128 of file time.c.

References isc_time::nanoseconds, REQUIRE, and isc_time::seconds.

Referenced by dns_badcache_add(), dns_badcache_flushname(), dns_badcache_flushtree(), dns_zone_create(), dump_done(), isc__timer_create(), isc__timer_reset(), isc__timermgr_create(), ns_server_zonestatus(), set_key_expiry_warning(), set_resigntime(), sync_keyzone(), was_dumping(), zone_dump(), zone_nsec3chain(), zone_refreshkeys(), zone_registerinclude(), zone_settimer(), and zone_sign().

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.

Definition at line 136 of file time.c.

References INSIST, ISC_FALSE, ISC_TRUE, isc_time::nanoseconds, NS_PER_S, REQUIRE, and isc_time::seconds.

Referenced by dispatch(), isc__timer_create(), isc__timer_reset(), mkey_status(), ns_server_zonestatus(), schedule(), zone_addnsec3chain(), zone_load(), zone_maintenance(), zone_needdump(), and zone_settimer().

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.

Definition at line 148 of file time.c.

References fix_tv_usec(), isc__strerror(), ISC_R_RANGE, ISC_R_SUCCESS, ISC_R_UNEXPECTED, ISC_STRERRORSIZE, isc_time::nanoseconds, NS_PER_US, REQUIRE, isc_time::seconds, UNEXPECTED_ERROR, and US_PER_S.

Referenced by adjust_quantum(), ATF_TC_BODY(), dns_badcache_add(), dns_badcache_flushname(), dns_badcache_flushtree(), dumptostreaminc(), free_rbtdb(), incremental_cleaning_action(), isc_httpd_recvdone(), isc_httpdmgr_addurl2(), load_configuration(), maybe_free(), ns_server_changezone(), ns_server_delzone(), setup(), view_find(), xfrin_create(), and xfrin_send_request().

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.

Definition at line 189 of file time.c.

References fix_tv_usec(), INSIST, isc__strerror(), ISC_R_RANGE, ISC_R_SUCCESS, ISC_R_UNEXPECTED, ISC_STRERRORSIZE, isc_time::nanoseconds, isc_interval::nanoseconds, NS_PER_S, NS_PER_US, REQUIRE, isc_time::seconds, isc_interval::seconds, UNEXPECTED_ERROR, and US_PER_S.

Referenced by dns_timer_setidle(), dns_zone_refresh(), fctx_create(), fctx_getaddresses(), ns_client_error(), set_timer(), zone_nsec3chain(), zone_resigninc(), and zone_sign().

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

Definition at line 239 of file time.c.

References INSIST, isc_time::nanoseconds, NS_PER_S, REQUIRE, and isc_time::seconds.

Referenced by badcache_resize(), dispatch(), dns_badcache_add(), dns_badcache_find(), dns_badcache_flushname(), dns_badcache_flushtree(), dns_badcache_print(), fctx_timeout(), isc_log_doit(), refresh_callback(), schedule(), set_refreshkeytimer(), sooner(), zone_maintenance(), zone_needdump(), zone_postload(), zone_settimer(), and zone_touched().

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.

Definition at line 255 of file time.c.

References INSIST, ISC_R_RANGE, ISC_R_SUCCESS, isc_interval::nanoseconds, isc_time::nanoseconds, NS_PER_S, REQUIRE, isc_interval::seconds, and isc_time::seconds.

Referenced by isc__timer_create(), isc__timer_reset(), isc__timer_touch(), and schedule().

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.

Definition at line 281 of file time.c.

References INSIST, ISC_R_RANGE, ISC_R_SUCCESS, isc_interval::nanoseconds, isc_time::nanoseconds, NS_PER_S, REQUIRE, isc_interval::seconds, and isc_time::seconds.

Referenced by isc_log_doit(), and setmodtime().

isc_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:

't1' and 't2' are valid pointers.

Returns:

The difference of t1 - t2, or 0 if t1 <= t2.

Definition at line 305 of file time.c.

References INSIST, isc_time::nanoseconds, NS_PER_S, NS_PER_US, REQUIRE, and isc_time::seconds.

Referenced by adjust_quantum(), dns_badcache_print(), dumptostreaminc(), evloop(), fctx_cancelquery(), fctx_sendevents(), maybe_free(), print_stats(), received(), and say_message().

isc_uint32_t isc_time_seconds ( const isc_time_t * t )

Return the number of seconds since the epoch stored in a time structure.

Requires:

't' is a valid pointer.

Definition at line 328 of file time.c.

References INSIST, isc_time::nanoseconds, NS_PER_S, REQUIRE, and isc_time::seconds.

Referenced by ATF_TC_BODY(), debug(), isc_file_settime(), ns_xfr_start(), query_find(), resquery_send(), schedule(), and zone_maintenance().

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:

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:

't' is a valid pointer.

Returns:

Success
Out of range

Definition at line 336 of file time.c.

References INSIST, ISC_R_RANGE, ISC_R_SUCCESS, isc_time::nanoseconds, NS_PER_S, REQUIRE, and isc_time::seconds.

Referenced by isc_condition_waituntil(), and render_xsl().

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.

Definition at line 373 of file time.c.

References ENSURE, isc_time::nanoseconds, NS_PER_S, and REQUIRE.

Referenced by debug(), isc_condition_waituntil(), isc_file_settime(), and kbdget().

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

Definition at line 382 of file time.c.

References INSIST, isc_time::nanoseconds, now, REQUIRE, and isc_time::seconds.

Referenced by dns_ntatable_totext(), isc_log_doit(), ns_server_dumpsecroots(), ns_server_nta(), set_key_expiry_warning(), set_refreshkeytimer(), and zone_refreshkeys().

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

Definition at line 401 of file time.c.

References INSIST, now, REQUIRE, and isc_time::seconds.

Referenced by ATF_TC_BODY(), isc_httpd_recvdone(), mkey_dumpzone(), mkey_status(), ns_server_status(), ns_server_zonestatus(), and totext_keydata().

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:

'buf' and 't' are not NULL.

Definition at line 416 of file time.c.

References ISC_R_SUCCESS, ISC_R_UNEXPECTED, isc_time_set(), isc_tm_strptime(), isc_tm_timegm(), and REQUIRE.

Referenced by ATF_TC_BODY(), ATF_TP_ADD_TCS(), and render_xsl().

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:

'len' > 0
'buf' points to an array of at least len chars

Definition at line 434 of file time.c.

References INSIST, now, REQUIRE, and isc_time::seconds.

Variable Documentation

const isc_interval_t* const isc_interval_zero

Definition at line 60 of file time.c.

Referenced by isc__timer_create(), and isc__timer_reset().

const isc_time_t* const isc_time_epoch

Definition at line 116 of file time.c.

Referenced by isc__timer_create(), and isc__timer_reset().

Generated on Tue Apr 28 17:41:19 2015 by Doxygen 1.5.4 for BIND9 Internals 9.11.0pre-alpha


Data Structures
struct	isc_interval
	The contents of this structure are private, and MUST NOT be accessed directly by callers. More...
struct	isc_time
	The contents of this structure are private, and MUST NOT be accessed directly by callers. More...
Defines
#define	ISC_TIME_H 1
#define	ISC_FORMATHTTPTIMESTAMP_SIZE 50
Functions
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().
isc_boolean_t	isc_interval_iszero (const isc_interval_t *i)
	Returns ISC_TRUE iff. 'i' is the zero interval.
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.
void	isc_time_settoepoch (isc_time_t *t)
	Set 't' to the time of the epoch.
isc_boolean_t	isc_time_isepoch (const isc_time_t *t)
	Returns ISC_TRUE iff. 't' is the epoch ("time zero").
isc_result_t	isc_time_now (isc_time_t *t)
	Set 't' to the current absolute time.
isc_result_t	isc_time_nowplusinterval (isc_time_t t, const isc_interval_t i)
	Set *t to the current absolute time + i.
int	isc_time_compare (const isc_time_t t1, const isc_time_t t2)
	Compare the times referenced by 't1' and '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'.
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'.
isc_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.
isc_uint32_t	isc_time_seconds (const isc_time_t *t)
	Return the number of seconds since the epoch stored in a time structure.
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.
isc_uint32_t	isc_time_nanoseconds (const isc_time_t *t)
	Return the number of nanoseconds stored in a time structure.
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.
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.
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".
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.
Variables
const isc_interval_t *const	isc_interval_zero
const isc_time_t *const	isc_time_epoch