granicus.if.org Git - apache/blob - include/util_time.h

   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * @file  util_time.h
  19  * @brief Apache date-time handling functions
  20  *
  21  * @defgroup APACHE_CORE_TIME Date-time handling functions
  22  * @ingroup  APACHE_CORE
  23  * @{
  24  */
  25
  26 #ifndef APACHE_UTIL_TIME_H
  27 #define APACHE_UTIL_TIME_H
  28
  29 #include "apr.h"
  30 #include "apr_time.h"
  31 #include "httpd.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  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!)
  40  */
  41 #define AP_TIME_RECENT_THRESHOLD 15
  42
  43 /* Options for ap_recent_ctime_ex */
  44 /* No extension */
  45 #define AP_CTIME_OPTION_NONE    0x0
  46 /* Add sub second timestamps with micro second resolution */
  47 #define AP_CTIME_OPTION_USEC    0x1
  48 /* Use more compact ISO 8601 format */
  49 #define AP_CTIME_OPTION_COMPACT 0x2
  50
  51
  52 /**
  53  * convert a recent time to its human readable components in local timezone
  54  * @param tm the exploded time
  55  * @param t the time to explode: MUST be within the last
  56  *          AP_TIME_RECENT_THRESHOLD seconds
  57  * @note This is a faster alternative to apr_time_exp_lt that uses
  58  *       a cache of pre-exploded time structures.  It is useful for things
  59  *       that need to explode the current time multiple times per second,
  60  *       like loggers.
  61  * @return APR_SUCCESS iff successful
  62  */
  63 AP_DECLARE(apr_status_t) ap_explode_recent_localtime(apr_time_exp_t *tm,
  64                                                      apr_time_t t);
  65
  66 /**
  67  * convert a recent time to its human readable components in GMT timezone
  68  * @param tm the exploded time
  69  * @param t the time to explode: MUST be within the last
  70  *          AP_TIME_RECENT_THRESHOLD seconds
  71  * @note This is a faster alternative to apr_time_exp_gmt that uses
  72  *       a cache of pre-exploded time structures.  It is useful for things
  73  *       that need to explode the current time multiple times per second,
  74  *       like loggers.
  75  * @return APR_SUCCESS iff successful
  76  */
  77 AP_DECLARE(apr_status_t) ap_explode_recent_gmt(apr_time_exp_t *tm,
  78                                                apr_time_t t);
  79
  80
  81 /**
  82  * format a recent timestamp in the ctime() format.
  83  * @param date_str String to write to.
  84  * @param t the time to convert
  85  * @note Consider using ap_recent_ctime_ex instead.
  86  * @return APR_SUCCESS iff successful
  87  */
  88 AP_DECLARE(apr_status_t) ap_recent_ctime(char *date_str, apr_time_t t);
  89
  90
  91 /**
  92  * format a recent timestamp in an extended ctime() format.
  93  * @param date_str String to write to.
  94  * @param t the time to convert
  95  * @param option Additional formatting options (AP_CTIME_OPTION_*).
  96  * @param len Pointer to an int containing the length of the provided buffer.
  97  *        On successful return it contains the number of bytes written to the
  98  *        buffer.
  99  * @return APR_SUCCESS iff successful, APR_ENOMEM if buffer was to short.
 100  */
 101 AP_DECLARE(apr_status_t) ap_recent_ctime_ex(char *date_str, apr_time_t t,
 102                                             int option, int *len);
 103
 104
 105 /**
 106  * format a recent timestamp in the RFC822 format
 107  * @param date_str String to write to (must have length >= APR_RFC822_DATE_LEN)
 108  * @param t the time to convert
 109  */
 110 AP_DECLARE(apr_status_t) ap_recent_rfc822_date(char *date_str, apr_time_t t);
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115
 116 #endif  /* !APACHE_UTIL_TIME_H */
 117 /** @} */