MySQL  8.0.20
Source Code Documentation
tztime.h
Go to the documentation of this file.
1 #ifndef TZTIME_INCLUDED
2 #define TZTIME_INCLUDED
3 
4 #include "my_config.h"
5 /* Copyright (c) 2004, 2019, Oracle and/or its affiliates. All rights reserved.
6 
7  This program is free software; you can redistribute it and/or modify
8  it under the terms of the GNU General Public License, version 2.0,
9  as published by the Free Software Foundation.
10 
11  This program is also distributed with certain software (including
12  but not limited to OpenSSL) that is licensed under separate terms,
13  as designated in a particular file or component or in included license
14  documentation. The authors of MySQL hereby grant you an additional
15  permission to link the program and your derivative works with the
16  separately licensed software that they have included with MySQL.
17 
18  This program is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  GNU General Public License, version 2.0, for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with this program; if not, write to the Free Software
25  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
26 
27 typedef long my_time_t;
28 
29 #if !defined(TESTTIME) && !defined(TZINFO2SQL)
30 
31 #include "my_inttypes.h"
32 
33 #ifdef HAVE_SYS_TIME_H
34 #include <sys/time.h>
35 #endif
36 #ifdef _WIN32
37 #include <winsock2.h>
38 #endif
39 
40 #include "mysql_time.h" // MYSQL_TIME
41 
42 class String;
43 class THD;
44 
45 /**
46  This class represents abstract time zone and provides
47  basic interface for MYSQL_TIME <-> my_time_t conversion.
48  Actual time zones which are specified by DB, or via offset
49  or use system functions are its descendants.
50 */
51 class Time_zone {
52  public:
53  /**
54  Converts local time in broken down MYSQL_TIME representation to
55  my_time_t (UTC seconds since Epoch) represenation.
56  Returns 0 in case of error. Sets in_dst_time_gap to true if date provided
57  falls into spring time-gap (or lefts it untouched otherwise).
58  */
59  virtual my_time_t TIME_to_gmt_sec(const MYSQL_TIME *t,
60  bool *in_dst_time_gap) const = 0;
61  /**
62  Converts time in my_time_t representation to local time in
63  broken down MYSQL_TIME representation.
64  */
65  virtual void gmt_sec_to_TIME(MYSQL_TIME *tmp, my_time_t t) const = 0;
66  /**
67  Comverts "struct timeval" to local time in
68  broken down MYSQL_TIME represendation.
69  */
70  void gmt_sec_to_TIME(MYSQL_TIME *tmp, struct timeval tv) {
71  gmt_sec_to_TIME(tmp, (my_time_t)tv.tv_sec);
72  tmp->second_part = tv.tv_usec;
73  }
74  /**
75  Because of constness of String returned by get_name() time zone name
76  have to be already zeroended to be able to use String::ptr() instead
77  of c_ptr().
78  */
79  virtual const String *get_name() const = 0;
80 
81  /**
82  We need this only for surpressing warnings, objects of this type are
83  allocated on MEM_ROOT and should not require destruction.
84  */
85  virtual ~Time_zone() = default;
86 
87  protected:
88  static inline void adjust_leap_second(MYSQL_TIME *t);
89 };
90 
91 extern Time_zone *my_tz_UTC;
92 extern Time_zone *my_tz_SYSTEM;
93 extern Time_zone *my_tz_OFFSET0;
94 extern Time_zone *my_tz_find(THD *thd, const String *name);
95 extern bool my_tz_init(THD *org_thd, const char *default_tzname,
96  bool bootstrap);
97 extern void my_tz_free();
99 
101 my_time_t use_input_time_zone(const MYSQL_TIME *input, bool *in_dst_time_gap);
102 void sec_to_TIME(MYSQL_TIME *tmp, my_time_t t, int64 offset);
103 
104 /**
105  Number of elements in table list produced by my_tz_get_table_list()
106  (this table list contains tables which are needed for dynamical loading
107  of time zone descriptions). Actually it is imlementation detail that
108  should not be used anywhere outside of tztime.h and tztime.cc.
109 */
110 
111 static const int MY_TZ_TABLES_COUNT = 4;
112 
113 #endif /* !defined(TESTTIME) && !defined(TZINFO2SQL) */
114 #endif /* TZTIME_INCLUDED */
unsigned long second_part
microseconds
Definition: mysql_time.h:83
Include file for Sun RPC to compile out of the box.
Some integer typedefs for easier portability.
bool my_tz_init(THD *org_thd, const char *default_tzname, bool bootstrap)
Definition: tztime.cc:1517
long my_time_t
Definition: tztime.h:27
[] long int my_time_t
Portable time_t replacement.
This class represents abstract time zone and provides basic interface for MYSQL_TIME <-> my_time_t co...
Definition: tztime.h:51
void my_tz_free()
Definition: tztime.cc:1685
Using this class is fraught with peril, and you need to be very careful when doing so...
Definition: sql_string.h:164
void adjust_time_zone_displacement(const Time_zone *tz, MYSQL_TIME *mt)
Converts a date/time value with time zone to the corresponding date/time value without time zone...
Definition: tztime.cc:1008
virtual void gmt_sec_to_TIME(MYSQL_TIME *tmp, my_time_t t) const =0
Converts time in my_time_t representation to local time in broken down MYSQL_TIME representation...
my_time_t use_input_time_zone(const MYSQL_TIME *input, bool *in_dst_time_gap)
static void adjust_leap_second(MYSQL_TIME *t)
Convert leap seconds into non-leap.
Definition: tztime.cc:2189
int64_t int64
Definition: my_inttypes.h:67
virtual const String * get_name() const =0
Because of constness of String returned by get_name() time zone name have to be already zeroended to ...
case opt name
Definition: sslopt-case.h:32
virtual ~Time_zone()=default
We need this only for surpressing warnings, objects of this type are allocated on MEM_ROOT and should...
Time_zone * my_tz_OFFSET0
Definition: tztime.cc:1382
Time_zone * my_tz_UTC
Definition: tztime.cc:1383
void gmt_sec_to_TIME(MYSQL_TIME *tmp, struct timeval tv)
Comverts "struct timeval" to local time in broken down MYSQL_TIME represendation. ...
Definition: tztime.h:70
Time_zone * my_tz_SYSTEM
Definition: tztime.cc:1384
Definition: mysql_time.h:81
Definition: bootstrap.cc:68
Time declarations shared between the server and client API: you should not add anything to this heade...
my_time_t sec_since_epoch_TIME(MYSQL_TIME *t)
void sec_to_TIME(MYSQL_TIME *tmp, my_time_t t, int64 offset)
Definition: tztime.cc:581
static const int MY_TZ_TABLES_COUNT
Number of elements in table list produced by my_tz_get_table_list() (this table list contains tables ...
Definition: tztime.h:111
virtual my_time_t TIME_to_gmt_sec(const MYSQL_TIME *t, bool *in_dst_time_gap) const =0
Converts local time in broken down MYSQL_TIME representation to my_time_t (UTC seconds since Epoch) r...
Time_zone * my_tz_find(THD *thd, const String *name)
Get Time_zone object for specified time zone.
Definition: tztime.cc:2126
For each client connection we create a separate thread with THD serving as a thread/connection descri...
Definition: sql_class.h:765