mysql_time.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. /* Copyright (c) 2004, 2006 MySQL AB
  2. Use is subject to license terms
  3. This program is free software; you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation; version 2 of the License.
  6. This program is distributed in the hope that it will be useful,
  7. but WITHOUT ANY WARRANTY; without even the implied warranty of
  8. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  9. GNU General Public License for more details.
  10. You should have received a copy of the GNU General Public License
  11. along with this program; if not, write to the Free Software
  12. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */
  13. #ifndef _mysql_time_h_
  14. #define _mysql_time_h_
  15. /*
  16. Portable time_t replacement.
  17. Should be signed and hold seconds for 1902 -- 2038-01-19 range
  18. i.e at least a 32bit variable
  19. Using the system built in time_t is not an option as
  20. we rely on the above requirements in the time functions
  21. */
  22. typedef long my_time_t;
  23. /*
  24. Time declarations shared between the server and client API:
  25. you should not add anything to this header unless it's used
  26. (and hence should be visible) in mysql.h.
  27. If you're looking for a place to add new time-related declaration,
  28. it's most likely my_time.h. See also "C API Handling of Date
  29. and Time Values" chapter in documentation.
  30. */
  31. enum enum_mysql_timestamp_type
  32. {
  33. MYSQL_TIMESTAMP_NONE= -2, MYSQL_TIMESTAMP_ERROR= -1,
  34. MYSQL_TIMESTAMP_DATE= 0, MYSQL_TIMESTAMP_DATETIME= 1, MYSQL_TIMESTAMP_TIME= 2
  35. };
  36. /*
  37. Structure which is used to represent datetime values inside MySQL.
  38. We assume that values in this structure are normalized, i.e. year <= 9999,
  39. month <= 12, day <= 31, hour <= 23, hour <= 59, hour <= 59. Many functions
  40. in server such as my_system_gmt_sec() or make_time() family of functions
  41. rely on this (actually now usage of make_*() family relies on a bit weaker
  42. restriction). Also functions that produce MYSQL_TIME as result ensure this.
  43. There is one exception to this rule though if this structure holds time
  44. value (time_type == MYSQL_TIMESTAMP_TIME) days and hour member can hold
  45. bigger values.
  46. */
  47. typedef struct st_mysql_time
  48. {
  49. unsigned int year, month, day, hour, minute, second;
  50. unsigned long second_part;
  51. my_bool neg;
  52. enum enum_mysql_timestamp_type time_type;
  53. } MYSQL_TIME;
  54. #endif /* _mysql_time_h_ */