home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277240_apr_time.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  8KB  |  245 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. #ifndef APR_TIME_H
  17. #define APR_TIME_H
  18.  
  19. /**
  20.  * @file apr_time.h
  21.  * @brief APR Time Library
  22.  */
  23.  
  24. #include "apr.h"
  25. #include "apr_pools.h"
  26. #include "apr_errno.h"
  27.  
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif /* __cplusplus */
  31.  
  32. /**
  33.  * @defgroup apr_time Time Routines
  34.  * @ingroup APR 
  35.  * @{
  36.  */
  37.  
  38. /** month names */
  39. APR_DECLARE_DATA extern const char apr_month_snames[12][4];
  40. /** day names */
  41. APR_DECLARE_DATA extern const char apr_day_snames[7][4];
  42.  
  43.  
  44. /** number of microseconds since 00:00:00 january 1, 1970 UTC */
  45. typedef apr_int64_t apr_time_t;
  46.  
  47.  
  48. /** mechanism to properly type apr_time_t literals */
  49. #define APR_TIME_C(val) APR_INT64_C(val)
  50.  
  51. /** mechanism to properly print apr_time_t values */
  52. #define APR_TIME_T_FMT APR_INT64_T_FMT
  53.  
  54. /** intervals for I/O timeouts, in microseconds */
  55. typedef apr_int64_t apr_interval_time_t;
  56. /** short interval for I/O timeouts, in microseconds */
  57. typedef apr_int32_t apr_short_interval_time_t;
  58.  
  59. /** number of microseconds per second */
  60. #define APR_USEC_PER_SEC APR_TIME_C(1000000)
  61.  
  62. /** @return apr_time_t as a second */
  63. #define apr_time_sec(time) ((time) / APR_USEC_PER_SEC)
  64.  
  65. /** @return apr_time_t as a usec */
  66. #define apr_time_usec(time) ((time) % APR_USEC_PER_SEC)
  67.  
  68. /** @return apr_time_t as a msec */
  69. #define apr_time_msec(time) (((time) / 1000) % 1000)
  70.  
  71. /** @return apr_time_t as a msec */
  72. #define apr_time_as_msec(time) ((time) / 1000)
  73.  
  74. /** @return a second as an apr_time_t */
  75. #define apr_time_from_sec(sec) ((apr_time_t)(sec) * APR_USEC_PER_SEC)
  76.  
  77. /** @return a second and usec combination as an apr_time_t */
  78. #define apr_time_make(sec, usec) ((apr_time_t)(sec) * APR_USEC_PER_SEC \
  79.                                 + (apr_time_t)(usec))
  80.  
  81. /**
  82.  * @return the current time
  83.  */
  84. APR_DECLARE(apr_time_t) apr_time_now(void);
  85.  
  86. /** @see apr_time_exp_t */
  87. typedef struct apr_time_exp_t apr_time_exp_t;
  88.  
  89. /**
  90.  * a structure similar to ANSI struct tm with the following differences:
  91.  *  - tm_usec isn't an ANSI field
  92.  *  - tm_gmtoff isn't an ANSI field (it's a bsdism)
  93.  */
  94. struct apr_time_exp_t {
  95.     /** microseconds past tm_sec */
  96.     apr_int32_t tm_usec;
  97.     /** (0-61) seconds past tm_min */
  98.     apr_int32_t tm_sec;
  99.     /** (0-59) minutes past tm_hour */
  100.     apr_int32_t tm_min;
  101.     /** (0-23) hours past midnight */
  102.     apr_int32_t tm_hour;
  103.     /** (1-31) day of the month */
  104.     apr_int32_t tm_mday;
  105.     /** (0-11) month of the year */
  106.     apr_int32_t tm_mon;
  107.     /** year since 1900 */
  108.     apr_int32_t tm_year;
  109.     /** (0-6) days since sunday */
  110.     apr_int32_t tm_wday;
  111.     /** (0-365) days since jan 1 */
  112.     apr_int32_t tm_yday;
  113.     /** daylight saving time */
  114.     apr_int32_t tm_isdst;
  115.     /** seconds east of UTC */
  116.     apr_int32_t tm_gmtoff;
  117. };
  118.  
  119. /**
  120.  * convert an ansi time_t to an apr_time_t
  121.  * @param result the resulting apr_time_t
  122.  * @param input the time_t to convert
  123.  */
  124. APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result, 
  125.                                                     time_t input);
  126.  
  127. /**
  128.  * convert a time to its human readable components using an offset
  129.  * from GMT
  130.  * @param result the exploded time
  131.  * @param input the time to explode
  132.  * @param offs the number of seconds offset to apply
  133.  */
  134. APR_DECLARE(apr_status_t) apr_time_exp_tz(apr_time_exp_t *result,
  135.                                           apr_time_t input,
  136.                                           apr_int32_t offs);
  137.  
  138. /** @deprecated @see apr_time_exp_tz */
  139. APR_DECLARE(apr_status_t) apr_explode_time(apr_time_exp_t *result,
  140.                                            apr_time_t input,
  141.                                            apr_int32_t offs);
  142.  
  143. /**
  144.  * convert a time to its human readable components in GMT timezone
  145.  * @param result the exploded time
  146.  * @param input the time to explode
  147.  */
  148. APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, 
  149.                                            apr_time_t input);
  150.  
  151. /**
  152.  * convert a time to its human readable components in local timezone
  153.  * @param result the exploded time
  154.  * @param input the time to explode
  155.  */
  156. APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, 
  157.                                           apr_time_t input);
  158.  
  159. /** @deprecated @see apr_time_exp_lt */
  160. APR_DECLARE(apr_status_t) apr_explode_localtime(apr_time_exp_t *result, 
  161.                                                 apr_time_t input);
  162.  
  163. /**
  164.  * Convert time value from human readable format to a numeric apr_time_t 
  165.  * e.g. elapsed usec since epoch
  166.  * @param result the resulting imploded time
  167.  * @param input the input exploded time
  168.  */
  169. APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, 
  170.                                            apr_time_exp_t *input);
  171.  
  172. /**
  173.  * Convert time value from human readable format to a numeric apr_time_t that
  174.  * always represents GMT
  175.  * @param result the resulting imploded time
  176.  * @param input the input exploded time
  177.  */
  178. APR_DECLARE(apr_status_t) apr_time_exp_gmt_get(apr_time_t *result, 
  179.                                                apr_time_exp_t *input);
  180.  
  181. /** @deprecated @see apr_time_exp_gmt_get */
  182. APR_DECLARE(apr_status_t) apr_implode_gmt(apr_time_t *result, 
  183.                                           apr_time_exp_t *input);
  184.  
  185. /**
  186.  * Sleep for the specified number of micro-seconds.
  187.  * @param t desired amount of time to sleep.
  188.  * @warning May sleep for longer than the specified time. 
  189.  */
  190. APR_DECLARE(void) apr_sleep(apr_interval_time_t t);
  191.  
  192. /** length of a RFC822 Date */
  193. #define APR_RFC822_DATE_LEN (30)
  194. /**
  195.  * apr_rfc822_date formats dates in the RFC822
  196.  * format in an efficient manner.  It is a fixed length
  197.  * format which requires the indicated amount of storage,
  198.  * including the trailing null byte.
  199.  * @param date_str String to write to.
  200.  * @param t the time to convert 
  201.  */
  202. APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t);
  203.  
  204. /** length of a CTIME date */
  205. #define APR_CTIME_LEN (25)
  206. /**
  207.  * apr_ctime formats dates in the ctime() format
  208.  * in an efficient manner.  it is a fixed length format
  209.  * and requires the indicated amount of storage including
  210.  * the trailing null byte.
  211.  * Unlike ANSI/ISO C ctime(), apr_ctime() does not include
  212.  * a \n at the end of the string.
  213.  * @param date_str String to write to.
  214.  * @param t the time to convert 
  215.  */
  216. APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t);
  217.  
  218. /**
  219.  * formats the exploded time according to the format specified
  220.  * @param s string to write to
  221.  * @param retsize The length of the returned string
  222.  * @param max The maximum length of the string
  223.  * @param format The format for the time string
  224.  * @param tm The time to convert
  225.  */
  226. APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, 
  227.                                        apr_size_t max, const char *format, 
  228.                                        apr_time_exp_t *tm);
  229.  
  230. /**
  231.  * Improve the clock resolution for the lifetime of the given pool.
  232.  * Generally this is only desireable on benchmarking and other very
  233.  * time-sensitive applications, and has no impact on most platforms.
  234.  * @param p The pool to associate the finer clock resolution 
  235.  */
  236. APR_DECLARE(void) apr_time_clock_hires(apr_pool_t *p);
  237.  
  238. /** @} */
  239.  
  240. #ifdef __cplusplus
  241. }
  242. #endif
  243.  
  244. #endif  /* ! APR_TIME_H */
  245.