1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
#ifndef APR_TIME_H
#define APR_TIME_H
#include "apr.h"
#include "apr_pools.h"
#include "apr_errno.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @package APR Time library
*/
APR_DECLARE_DATA extern const char apr_month_snames[12][4];
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;
typedef apr_int32_t apr_short_interval_time_t;
#define APR_USEC_PER_SEC APR_TIME_C(1000000)
/**
* return the current time
* @deffunc apr_time_t apr_time_now(void)
*/
APR_DECLARE(apr_time_t) apr_time_now(void);
typedef struct apr_exploded_time_t apr_exploded_time_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_exploded_time_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 jan 1 */
apr_int32_t tm_yday;
/** daylight saving time */
apr_int32_t tm_isdst;
/** seconds east of UTC */
apr_int32_t tm_gmtoff;
};
/**
* convert an ansi time_t to an apr_time_t
* @param result the resulting apr_time_t
* @param input the time_t to convert
* @deffunc apr_status_t apr_ansi_time_to_apr_time(apr_time_t *result, time_t input)
*/
APR_DECLARE(apr_status_t) apr_ansi_time_to_apr_time(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
* @param zone the zone description
* @deffunc apr_status_t apr_explode_time(apr_exploded_time_t *result, apr_time_t input, apr_int32_t offs)
*/
APR_DECLARE(apr_status_t) apr_explode_time(apr_exploded_time_t *result,
apr_time_t input,
apr_int32_t offs);
/**
* convert a time to its human readable components in GMT timezone
* @param result the exploded time
* @param input the time to explode
* @deffunc apr_status_t apr_explode_gmt(apr_exploded_time_t *result, apr_time_t input)
*/
APR_DECLARE(apr_status_t) apr_explode_gmt(apr_exploded_time_t *result,
apr_time_t input);
/**
* convert a time to its human readable components in local timezone
* @param result the exploded time
* @param input the time to explode
* @deffunc apr_status_t apr_explode_localtime(apr_exploded_time_t *result, apr_time_t input)
*/
APR_DECLARE(apr_status_t) apr_explode_localtime(apr_exploded_time_t *result,
apr_time_t input);
/**
* Convert time value from human readable format to a numeric apr_time_t
* e.g. elapsed usec since epoch
* @param result the resulting imploded time
* @param input the input exploded time
* @deffunc apr_status_t apr_implode_time(apr_time_t *result, apr_exploded_time_t *input)
*/
APR_DECLARE(apr_status_t) apr_implode_time(apr_time_t *result,
apr_exploded_time_t *input);
/**
* Sleep for the specified number of micro-seconds.
* @param t desired amount of time to sleep.
* @deffunc void apr_sleep(apr_interval_time_t t)
* @tip May sleep for longer than the specified time.
*/
APR_DECLARE(void) apr_sleep(apr_interval_time_t t);
#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 and requires the indicated amount of storage
* including trailing \0
* @param date_str String to write to.
* @param t the time to convert
* @deffunc apr_status_t apr_rfc822_date(char *date_str, apr_time_t t)
*/
APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t);
#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 the indicated amount of storage
* including trailing \0
* @param date_str String to write to.
* @param t the time to convert
* @deffunc apr_status_t apr_ctime(char *date_str, apr_time_t t)
*/
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
* @deffunc apr_status_t apr_strftime(char *s, apr_size_t *retsize, apr_size_t max, const char *format, apr_exploded_time_t *tm)
*/
APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize,
apr_size_t max, const char *format,
apr_exploded_time_t *tm);
#ifdef __cplusplus
}
#endif
#endif /* ! APR_TIME_H */
|
