Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

apr_time.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  */
00054 
00055 #ifndef APR_TIME_H
00056 #define APR_TIME_H
00057 
00063 #include "apr.h"
00064 #include "apr_pools.h"
00065 #include "apr_errno.h"
00066 
00067 #ifdef __cplusplus
00068 extern "C" {
00069 #endif /* __cplusplus */
00070 
00078 APR_DECLARE_DATA extern const char apr_month_snames[12][4];
00080 APR_DECLARE_DATA extern const char apr_day_snames[7][4];
00081 
00082 
00084 typedef apr_int64_t apr_time_t;
00085 
00086 
00088 #define APR_TIME_C(val) APR_INT64_C(val)
00089 
00091 #define APR_TIME_T_FMT APR_INT64_T_FMT
00092 
00094 typedef apr_int64_t apr_interval_time_t;
00096 typedef apr_int32_t apr_short_interval_time_t;
00097 
00099 #define APR_USEC_PER_SEC APR_TIME_C(1000000)
00100 
00102 #define apr_time_sec(time) ((time) / APR_USEC_PER_SEC)
00103 
00105 #define apr_time_usec(time) ((time) % APR_USEC_PER_SEC)
00106 
00108 #define apr_time_msec(time) (((time) / 1000) % 1000)
00109 
00111 #define apr_time_as_msec(time) ((time) / 1000)
00112 
00114 #define apr_time_from_sec(sec) ((apr_time_t)(sec) * APR_USEC_PER_SEC)
00115 
00117 #define apr_time_make(sec, usec) ((apr_time_t)(sec) * APR_USEC_PER_SEC \
00118                                 + (apr_time_t)(usec))
00119 
00123 APR_DECLARE(apr_time_t) apr_time_now(void);
00124 
00126 typedef struct apr_time_exp_t apr_time_exp_t;
00127 
00133 struct apr_time_exp_t {
00135     apr_int32_t tm_usec;
00137     apr_int32_t tm_sec;
00139     apr_int32_t tm_min;
00141     apr_int32_t tm_hour;
00143     apr_int32_t tm_mday;
00145     apr_int32_t tm_mon;
00147     apr_int32_t tm_year;
00149     apr_int32_t tm_wday;
00151     apr_int32_t tm_yday;
00153     apr_int32_t tm_isdst;
00155     apr_int32_t tm_gmtoff;
00156 };
00157 
00163 APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result, 
00164                                                     time_t input);
00165 
00173 APR_DECLARE(apr_status_t) apr_time_exp_tz(apr_time_exp_t *result,
00174                                           apr_time_t input,
00175                                           apr_int32_t offs);
00176 
00178 APR_DECLARE(apr_status_t) apr_explode_time(apr_time_exp_t *result,
00179                                            apr_time_t input,
00180                                            apr_int32_t offs);
00181 
00187 APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, 
00188                                            apr_time_t input);
00189 
00195 APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, 
00196                                           apr_time_t input);
00197 
00199 APR_DECLARE(apr_status_t) apr_explode_localtime(apr_time_exp_t *result, 
00200                                                 apr_time_t input);
00201 
00208 APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, 
00209                                            apr_time_exp_t *input);
00210 
00217 APR_DECLARE(apr_status_t) apr_time_exp_gmt_get(apr_time_t *result, 
00218                                                apr_time_exp_t *input);
00219 
00221 APR_DECLARE(apr_status_t) apr_implode_gmt(apr_time_t *result, 
00222                                           apr_time_exp_t *input);
00223 
00229 APR_DECLARE(void) apr_sleep(apr_interval_time_t t);
00230 
00232 #define APR_RFC822_DATE_LEN (30)
00241 APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t);
00242 
00244 #define APR_CTIME_LEN (25)
00255 APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t);
00256 
00265 APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, 
00266                                        apr_size_t max, const char *format, 
00267                                        apr_time_exp_t *tm);
00268 
00275 APR_DECLARE(void) apr_time_clock_hires(apr_pool_t *p);
00276 
00279 #ifdef __cplusplus
00280 }
00281 #endif
00282 
00283 #endif  /* ! APR_TIME_H */

Generated on Tue May 31 15:59:22 2011 for Apache Portable Runtime by  doxygen 1.3.9.1