github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/include/util_time.h (about)

     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  /**
    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,
    51   *       like loggers.
    52   * @return APR_SUCCESS iff successful
    53   */
    54  AP_DECLARE(apr_status_t) ap_explode_recent_localtime(apr_time_exp_t *tm,
    55                                                       apr_time_t t);
    56  
    57  /**
    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,
    65   *       like loggers.
    66   * @return APR_SUCCESS iff successful
    67   */
    68  AP_DECLARE(apr_status_t) ap_explode_recent_gmt(apr_time_exp_t *tm,
    69                                                 apr_time_t t);
    70  
    71  
    72  /**
    73   * format a recent timestamp in the ctime() format.
    74   * @param date_str String to write to.
    75   * @param t the time to convert 
    76   */
    77  AP_DECLARE(apr_status_t) ap_recent_ctime(char *date_str, apr_time_t t);
    78  
    79  /**
    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 
    83   */
    84  AP_DECLARE(apr_status_t) ap_recent_rfc822_date(char *date_str, apr_time_t t);
    85  
    86  #ifdef __cplusplus
    87  }
    88  #endif
    89  
    90  #endif  /* !APACHE_UTIL_TIME_H */
    91  /** @} */