1 /*##############################################################################
2  VSQLite++ - virtuosic bytes SQLite3 C++ wrapper
3 
4  Copyright (c) 2006-2014 Vinzenz Feenstra vinzenz.feenstra@gmail.com
5  Copyright (c) 2014 mickey mickey.mouse-1985@libero.it
6  All rights reserved.
7 
8  Redistribution and use in source and binary forms, with or without modification,
9  are permitted provided that the following conditions are met:
10 
11  * Redistributions of source code must retain the above copyright notice,
12    this list of conditions and the following disclaimer.
13  * Redistributions in binary form must reproduce the above copyright notice,
14    this list of conditions and the following disclaimer in the documentation
15    and/or other materials provided with the distribution.
16  * Neither the name of virtuosic bytes nor the names of its contributors may
17    be used to endorse or promote products derived from this software without
18    specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31 
32 ##############################################################################*/
33 #ifndef GUARD_SQLITE_TRANSACTION_HPP_INCLUDED
34 #define GUARD_SQLITE_TRANSACTION_HPP_INCLUDED
35 
36 namespace sqlite{
37     struct connection;
38 
39     /** \brief Defines the kind of transaction to begin.
40      *
41      * \see http://www.sqlite.org/lang_transaction.html for documentation
42      * about transaction kind.
43      *
44      * When no transaction type is defined (\c undefined) the default behaviour
45      * is to create a deferred transaction, but the \c undefined constant is
46      * because maybe in future the default behaviour may change.
47      *
48      * Note that for more type safety this needs Strongly Typed enums C++11
49      * feature:
50      * http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2347.pdf
51      */
52     enum class transaction_type {
53         undefined,
54         deferred,
55         immediate,
56         exclusive
57     };
58 
59     /** \brief transaction is a helper class to start transactions within SQLite
60       *
61       */
62     struct transaction{
63     public:
64         /** \brief constructor
65           * \param con a reference to the connection object where the
66           * transaction should be started/ended/committed or rolled back
67           * \param type define the transaction type
68           */
69         transaction(connection & con, transaction_type type = transaction_type::undefined);
70 
71         /** \brief destructor
72           *
73           */
74         ~transaction();
75 
76         /** \brief Starts a transaction
77           * \param type define the transaction type
78           */
79         void begin(transaction_type type = transaction_type::undefined);
80 
81         /** \brief Ends an transaction
82           *
83           */
84         void end();
85 
86         /** \brief Commits a transaction
87           *
88           */
89         void commit();
90 
91         /** \brief Rolls back a transaction
92           *
93           */
94         void rollback();
95 
96         /** \brief Allow to check if transaction handled by this object is
97           * currently active
98           * \return \c true if transaction is still active, \c false otherwise
99           */
isActivesqlite::transaction100         bool isActive() const { return m_isActive; }
101     private:
102         void exec(std::string const &);
103         connection & m_con;
104         bool m_isActive; ///< if \c true there is a transaction currently opened
105     };
106 }
107 
108 #endif //GUARD_SQLITE_TRANSACTION_HPP_INCLUDED
109 
110