123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237 |
- /* Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- #ifndef APR_TIME_H
- #define APR_TIME_H
- /**
- * @file apr_time.h
- * @brief APR Time Library
- */
- #include "apr.h"
- #include "apr_errno.h"
- #ifdef __cplusplus
- extern "C" {
- #endif /* __cplusplus */
- /**
- * @defgroup apr_time Time Routines
- * @ingroup APR
- * @{
- */
- /** month names */
- APR_DECLARE_DATA extern const char apr_month_snames[12][4];
- /** day names */
- APR_DECLARE_DATA extern const char apr_day_snames[7][4];
- /** number of microseconds since 00:00:00 January 1, 1970 UTC */
- typedef apr_int64_t apr_time_t;
- /** mechanism to properly type apr_time_t literals */
- #define APR_TIME_C(val) APR_INT64_C(val)
- /** mechanism to properly print apr_time_t values */
- #define APR_TIME_T_FMT APR_INT64_T_FMT
- /** intervals for I/O timeouts, in microseconds */
- typedef apr_int64_t apr_interval_time_t;
- /** short interval for I/O timeouts, in microseconds */
- typedef apr_int32_t apr_short_interval_time_t;
- /** number of microseconds per second */
- #define APR_USEC_PER_SEC APR_TIME_C(1000000)
- /** @return apr_time_t as a second */
- #define apr_time_sec(time) ((time) / APR_USEC_PER_SEC)
- /** @return apr_time_t as a usec */
- #define apr_time_usec(time) ((time) % APR_USEC_PER_SEC)
- /** @return apr_time_t as a msec */
- #define apr_time_msec(time) (((time) / 1000) % 1000)
- /** @return apr_time_t as a msec */
- #define apr_time_as_msec(time) ((time) / 1000)
- /** @return milliseconds as an apr_time_t */
- #define apr_time_from_msec(msec) ((apr_time_t)(msec) * 1000)
- /** @return seconds as an apr_time_t */
- #define apr_time_from_sec(sec) ((apr_time_t)(sec) * APR_USEC_PER_SEC)
- /** @return a second and usec combination as an apr_time_t */
- #define apr_time_make(sec, usec) ((apr_time_t)(sec) * APR_USEC_PER_SEC \
- + (apr_time_t)(usec))
- /**
- * @return the current time
- */
- APR_DECLARE(apr_time_t) apr_time_now(void);
- /** @see apr_time_exp_t */
- typedef struct apr_time_exp_t apr_time_exp_t;
- /**
- * a structure similar to ANSI struct tm with the following differences:
- * - tm_usec isn't an ANSI field
- * - tm_gmtoff isn't an ANSI field (it's a BSDism)
- */
- struct apr_time_exp_t {
- /** microseconds past tm_sec */
- apr_int32_t tm_usec;
- /** (0-61) seconds past tm_min */
- apr_int32_t tm_sec;
- /** (0-59) minutes past tm_hour */
- apr_int32_t tm_min;
- /** (0-23) hours past midnight */
- apr_int32_t tm_hour;
- /** (1-31) day of the month */
- apr_int32_t tm_mday;
- /** (0-11) month of the year */
- apr_int32_t tm_mon;
- /** year since 1900 */
- apr_int32_t tm_year;
- /** (0-6) days since Sunday */
- apr_int32_t tm_wday;
- /** (0-365) days since January 1 */
- apr_int32_t tm_yday;
- /** daylight saving time */
- apr_int32_t tm_isdst;
- /** seconds east of UTC */
- apr_int32_t tm_gmtoff;
- };
- /* Delayed the include to avoid a circular reference */
- #include "apr_pools.h"
- /**
- * Convert an ansi time_t to an apr_time_t
- * @param result the resulting apr_time_t
- * @param input the time_t to convert
- */
- APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result,
- time_t input);
- /**
- * Convert a time to its human readable components using an offset
- * from GMT.
- * @param result the exploded time
- * @param input the time to explode
- * @param offs the number of seconds offset to apply
- */
- APR_DECLARE(apr_status_t) apr_time_exp_tz(apr_time_exp_t *result,
- apr_time_t input,
- apr_int32_t offs);
- /**
- * Convert a time to its human readable components (GMT).
- * @param result the exploded time
- * @param input the time to explode
- */
- APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result,
- apr_time_t input);
- /**
- * Convert a time to its human readable components in the local timezone.
- * @param result the exploded time
- * @param input the time to explode
- */
- APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result,
- apr_time_t input);
- /**
- * Convert time value from human readable format to a numeric apr_time_t
- * (elapsed microseconds since the epoch).
- * @param result the resulting imploded time
- * @param input the input exploded time
- */
- APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result,
- apr_time_exp_t *input);
- /**
- * Convert time value from human readable format to a numeric apr_time_t that
- * always represents GMT.
- * @param result the resulting imploded time
- * @param input the input exploded time
- */
- APR_DECLARE(apr_status_t) apr_time_exp_gmt_get(apr_time_t *result,
- apr_time_exp_t *input);
- /**
- * Sleep for the specified number of micro-seconds.
- * @param t desired amount of time to sleep.
- * @warning May sleep for longer than the specified time.
- */
- APR_DECLARE(void) apr_sleep(apr_interval_time_t t);
- /** length of a RFC822 Date */
- #define APR_RFC822_DATE_LEN (30)
- /**
- * apr_rfc822_date formats dates in the RFC822
- * format in an efficient manner. It is a fixed length
- * format which requires APR_RFC822_DATA_LEN bytes of storage,
- * including the trailing NUL terminator.
- * @param date_str String to write to.
- * @param t the time to convert
- */
- APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t);
- /** length of a CTIME date */
- #define APR_CTIME_LEN (25)
- /**
- * apr_ctime formats dates in the ctime() format
- * in an efficient manner. It is a fixed length format
- * and requires APR_CTIME_LEN bytes of storage including
- * the trailing NUL terminator.
- * Unlike ANSI/ISO C ctime(), apr_ctime() does not include
- * a \\n at the end of the string.
- * @param date_str String to write to.
- * @param t the time to convert
- */
- APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t);
- /**
- * Formats the exploded time according to the format specified
- * @param s string to write to
- * @param retsize The length of the returned string
- * @param max The maximum length of the string
- * @param format The format for the time string
- * @param tm The time to convert
- */
- APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize,
- apr_size_t max, const char *format,
- apr_time_exp_t *tm);
- /**
- * Improve the clock resolution for the lifetime of the given pool.
- * Generally this is only desirable on benchmarking and other very
- * time-sensitive applications, and has no impact on most platforms.
- * @param p The pool to associate the finer clock resolution
- */
- APR_DECLARE(void) apr_time_clock_hires(apr_pool_t *p);
- /** @} */
- #ifdef __cplusplus
- }
- #endif
- #endif /* ! APR_TIME_H */
|