Date-time handling functions

Collaboration diagram for Date-time handling functions:

Macros
#define	AP_TIME_RECENT_THRESHOLD   15
#define	AP_CTIME_OPTION_NONE   0x0
#define	AP_CTIME_OPTION_USEC   0x1
#define	AP_CTIME_OPTION_COMPACT   0x2
#define	AP_CTIME_OPTION_GMTOFF   0x4

Functions
apr_status_t	ap_explode_recent_localtime (apr_time_exp_t *tm, apr_time_t t)
apr_status_t	ap_explode_recent_gmt (apr_time_exp_t *tm, apr_time_t t)
apr_status_t	ap_recent_ctime (char *date_str, apr_time_t t)
apr_status_t	ap_recent_ctime_ex (char *date_str, apr_time_t t, int option, int *len)
apr_status_t	ap_recent_rfc822_date (char *date_str, apr_time_t t)
void	ap_force_set_tz (apr_pool_t *p)

Detailed Description

Macro Definition Documentation

AP_CTIME_OPTION_COMPACT

#define AP_CTIME_OPTION_COMPACT   0x2

AP_CTIME_OPTION_GMTOFF

#define AP_CTIME_OPTION_GMTOFF   0x4

AP_CTIME_OPTION_NONE

#define AP_CTIME_OPTION_NONE   0x0

AP_CTIME_OPTION_USEC

#define AP_CTIME_OPTION_USEC   0x1

AP_TIME_RECENT_THRESHOLD

#define AP_TIME_RECENT_THRESHOLD   15

Function Documentation

ap_explode_recent_gmt()

apr_status_t ap_explode_recent_gmt	(	apr_time_exp_t *	tm,
		apr_time_t	t
	)

convert a recent time to its human readable components in GMT timezone

Parameters

tm	the exploded time
t	the time to explode: MUST be within the last AP_TIME_RECENT_THRESHOLD seconds

Note

This is a faster alternative to apr_time_exp_gmt that uses a cache of pre-exploded time structures. It is useful for things that need to explode the current time multiple times per second, like loggers.

Returns

APR_SUCCESS iff successful

ap_explode_recent_localtime()

apr_status_t ap_explode_recent_localtime	(	apr_time_exp_t *	tm,
		apr_time_t	t
	)

convert a recent time to its human readable components in local timezone

Parameters

tm	the exploded time
t	the time to explode: MUST be within the last AP_TIME_RECENT_THRESHOLD seconds

Note

This is a faster alternative to apr_time_exp_lt that uses a cache of pre-exploded time structures. It is useful for things that need to explode the current time multiple times per second, like loggers.

Returns

APR_SUCCESS iff successful

ap_force_set_tz()

void ap_force_set_tz

(

apr_pool_t *

p

)

Force an unset TZ to UTC

Parameters

p	the pool to use

ap_recent_ctime()

apr_status_t ap_recent_ctime	(	char *	date_str,
		apr_time_t	t
	)

format a recent timestamp in the ctime() format.

Parameters

date_str	String to write to.
t	the time to convert

Note

Consider using ap_recent_ctime_ex instead.

Returns

APR_SUCCESS iff successful

ap_recent_ctime_ex()

apr_status_t ap_recent_ctime_ex	(	char *	date_str,
		apr_time_t	t,
		int	option,
		int *	len
	)

format a recent timestamp in an extended ctime() format.

Parameters

date_str	String to write to.
t	the time to convert
option	Additional formatting options (AP_CTIME_OPTION_*).
len	Pointer to an int containing the length of the provided buffer. On successful return it contains the number of bytes written to the buffer (including trailing NUL byte).

Returns

APR_SUCCESS iff successful, APR_ENOMEM if buffer was to short.

ap_recent_rfc822_date()

apr_status_t ap_recent_rfc822_date	(	char *	date_str,
		apr_time_t	t
	)

format a recent timestamp in the RFC822 format

Parameters

date_str	String to write to (must have length >= APR_RFC822_DATE_LEN)
t	the time to convert