1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief Apache date-time handling functions
21 * @defgroup APACHE_CORE_TIME Date-time handling functions
22 * @ingroup APACHE_CORE
26 #ifndef APACHE_UTIL_TIME_H
27 #define APACHE_UTIL_TIME_H
37 /* Maximum delta from the current time, in seconds, for a past time
38 * to qualify as "recent" for use in the ap_explode_recent_*() functions:
39 * (Must be a power of two minus one!)
41 #define AP_TIME_RECENT_THRESHOLD 15
44 * convert a recent time to its human readable components in local timezone
45 * @param tm the exploded time
46 * @param t the time to explode: MUST be within the last
47 * AP_TIME_RECENT_THRESHOLD seconds
48 * @note This is a faster alternative to apr_time_exp_lt that uses
49 * a cache of pre-exploded time structures. It is useful for things
50 * that need to explode the current time multiple times per second,
52 * @return APR_SUCCESS iff successful
54 AP_DECLARE(apr_status_t) ap_explode_recent_localtime(apr_time_exp_t *tm,
58 * convert a recent time to its human readable components in GMT timezone
59 * @param tm the exploded time
60 * @param t the time to explode: MUST be within the last
61 * AP_TIME_RECENT_THRESHOLD seconds
62 * @note This is a faster alternative to apr_time_exp_gmt that uses
63 * a cache of pre-exploded time structures. It is useful for things
64 * that need to explode the current time multiple times per second,
66 * @return APR_SUCCESS iff successful
68 AP_DECLARE(apr_status_t) ap_explode_recent_gmt(apr_time_exp_t *tm,
73 * format a recent timestamp in the ctime() format.
74 * @param date_str String to write to.
75 * @param t the time to convert
77 AP_DECLARE(apr_status_t) ap_recent_ctime(char *date_str, apr_time_t t);
80 * format a recent timestamp in the RFC822 format
81 * @param date_str String to write to (must have length >= APR_RFC822_DATE_LEN)
82 * @param t the time to convert
84 AP_DECLARE(apr_status_t) ap_recent_rfc822_date(char *date_str, apr_time_t t);
90 #endif /* !APACHE_UTIL_TIME_H */