A lot of doxygen updates
[asterisk/asterisk.git] / include / asterisk / localtime.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Tilghman Lesher <tlesher@vcch.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  * \brief Custom localtime functions for multiple timezones
22  */
23
24 #ifndef _ASTERISK_LOCALTIME_H
25 #define _ASTERISK_LOCALTIME_H
26
27 struct ast_tm {
28         int tm_sec;             /*!< Seconds. [0-60] (1 leap second) */
29         int tm_min;             /*!< Minutes. [0-59] */
30         int tm_hour;            /*!< Hours.   [0-23] */
31         int tm_mday;            /*!< Day.     [1-31] */
32         int tm_mon;             /*!< Month.   [0-11] */
33         int tm_year;            /*!< Year - 1900.  */
34         int tm_wday;            /*!< Day of week. [0-6] */
35         int tm_yday;            /*!< Days in year.[0-365]       */
36         int tm_isdst;           /*!< DST.               [-1/0/1]*/
37         long int tm_gmtoff;     /*!< Seconds east of UTC.  */
38         char *tm_zone;          /*!< Timezone abbreviation.  */
39         /* NOTE: do NOT reorder this final item.  The order needs to remain compatible with struct tm */
40         int tm_usec;        /*!< microseconds */
41 };
42
43 struct ast_tm *ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone);
44 struct timeval ast_mktime(struct ast_tm * const tmp, const char *zone);
45 int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm);
46
47 #endif /* _ASTERISK_LOCALTIME_H */