1 /*****************************************************************************
2 
3 Copyright (c) 1996, 2019, Oracle and/or its affiliates. All Rights Reserved.
4 
5 This program is free software; you can redistribute it and/or modify it under
6 the terms of the GNU General Public License, version 2.0, as published by the
7 Free Software Foundation.
8 
9 This program is also distributed with certain software (including but not
10 limited to OpenSSL) that is licensed under separate terms, as designated in a
11 particular file or component or in included license documentation. The authors
12 of MySQL hereby grant you an additional permission to link the program and
13 your derivative works with the separately licensed software that they have
14 included with MySQL.
15 
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
19 for more details.
20 
21 You should have received a copy of the GNU General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc.,
23 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
24 
25 *****************************************************************************/
26 
27 /** @file include/usr0sess.h
28  Sessions
29 
30  Created 6/25/1996 Heikki Tuuri
31  *******************************************************/
32 
33 #ifndef usr0sess_h
34 #define usr0sess_h
35 
36 #include "data0data.h"
37 #include "que0types.h"
38 #include "rem0rec.h"
39 #include "srv0srv.h"
40 #include "trx0types.h"
41 #include "univ.i"
42 #include "usr0types.h"
43 #include "ut0byte.h"
44 
45 /** Opens a session.
46  @return own: session object */
47 sess_t *sess_open(void);
48 /** Closes a session, freeing the memory occupied by it. */
49 void sess_close(sess_t *sess); /* in, own: session object */
50 
51 /* The session handle. This data structure is only used by purge and is
52 not really necessary. We should get rid of it. */
53 struct sess_t {
54   ulint state; /*!< state of the session */
55   trx_t *trx;  /*!< transaction object permanently
56                assigned for the session: the
57                transaction instance designated by the
58                trx id changes, but the memory
59                structure is preserved */
60 };
61 
62 /* Session states */
63 #define SESS_ACTIVE 1
64 #define SESS_ERROR                       \
65   2 /* session contains an error message \
66     which has not yet been communicated  \
67     to the client */
68 
69 #endif
70