/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc

« back to all changes in this revision

Viewing changes to include/sqlite3cc/transaction.h

  • Committer: Tim Marston
  • Date: 2015-02-26 08:59:36 UTC
  • Revision ID: tim@ed.am-20150226085936-xe43in8bfz6f6nxb
fixed some missing/incorrect includes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
/*
2
2
 * transaction.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of sqlite3cc (hereafter referred to as "this program").
7
 
 * See http://www.waxworlds.org/edam/software/sqlite3cc for more information.
8
 
 *
9
 
 * This program is free software: you can redistribute it and/or modify
10
 
 * it under the terms of the GNU Lesser General Public License as published
11
 
 * by the Free Software Foundation, either version 3 of the License, or
12
 
 * (at your option) any later version.
13
 
 *
14
 
 * This program is distributed in the hope that it will be useful,
15
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 
 * GNU Lesser General Public License for more details.
 
7
 * See http://ed.am/dev/sqlite3cc for more information.
 
8
 *
 
9
 * This program is free software: you can redistribute it and/or modify it under
 
10
 * the terms of the GNU Lesser General Public License as published by the Free
 
11
 * Software Foundation, either version 3 of the License, or (at your option) any
 
12
 * later version.
 
13
 *
 
14
 * This program is distributed in the hope that it will be useful, but WITHOUT
 
15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 
16
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 
17
 * details.
18
18
 *
19
19
 * You should have received a copy of the GNU Lesser General Public License
20
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
32
32
{
33
33
 
34
34
 
35
 
class database;
36
 
 
37
 
 
38
 
/**
39
 
 * A basic (default, deferred) transaction.
40
 
 */
41
 
class basic_transaction
42
 
        :
43
 
        private boost::noncopyable
 
35
class connection;
 
36
 
 
37
 
 
38
namespace detail
44
39
{
45
 
//______________________________________________________________________________
46
 
//                                                                 instantiation
47
 
public:
48
 
 
49
 
        /**
50
 
         * Constructor that provides a database upon which to act
51
 
         * @param database a database
52
 
         */
53
 
        explicit basic_transaction(
54
 
                database &database );
55
 
 
56
 
//______________________________________________________________________________
57
 
//                                                              public interface
58
 
public:
59
 
 
60
 
        /**
61
 
         * Begin the transaction
62
 
         */
63
 
        virtual void begin();
64
 
 
65
 
        /**
66
 
         * Commit the transaction
67
 
         */
68
 
        virtual void commit();
69
 
 
70
 
        /**
71
 
         * Rollback the transaction
72
 
         */
73
 
        virtual void rollback();
74
 
 
75
 
//______________________________________________________________________________
76
 
//                                                                implementation
77
 
protected:
78
 
 
79
 
        /** close any in-progress statements */
80
 
        void invalidate_queries();
81
 
 
82
 
        /** the database on which to act */
83
 
        database &_database;
84
 
 
85
 
};
86
 
 
87
 
 
88
 
////////////////////////////////////////////////////////////////////////////////
89
 
 
90
 
 
91
 
/**
92
 
 * An exclusive transaction
 
40
 
 
41
        /**
 
42
         * A basic (default, deferred) transaction.
 
43
         */
 
44
        class basic_transaction
 
45
                :
 
46
                private boost::noncopyable
 
47
        {
 
48
        //__________________________________________________________________________
 
49
        //                                                             instantiation
 
50
        public:
 
51
 
 
52
                /**
 
53
                 * Constructor that provides a connection upon which to act.
 
54
                 *
 
55
                 * @param connection a connection
 
56
                 */
 
57
                explicit basic_transaction(
 
58
                        connection &connection );
 
59
 
 
60
        //__________________________________________________________________________
 
61
        //                                                          public interface
 
62
        public:
 
63
 
 
64
                /**
 
65
                 * Begin the transaction
 
66
                 */
 
67
                virtual void begin();
 
68
 
 
69
                /**
 
70
                 * Commit the transaction
 
71
                 */
 
72
                virtual void commit();
 
73
 
 
74
                /**
 
75
                 * Rollback the transaction
 
76
                 */
 
77
                virtual void rollback();
 
78
 
 
79
        //__________________________________________________________________________
 
80
        //                                                            implementation
 
81
        protected:
 
82
 
 
83
                /** reset any in-progress statements */
 
84
                void reset_active_queries();
 
85
 
 
86
                /** the connection on which to act */
 
87
                connection &_connection;
 
88
 
 
89
        };
 
90
 
 
91
} // namespace detail
 
92
 
 
93
 
 
94
////////////////////////////////////////////////////////////////////////////////
 
95
 
 
96
 
 
97
/**
 
98
 * A deferred transaction.
 
99
 */
 
100
typedef detail::basic_transaction deferred_transaction;
 
101
 
 
102
 
 
103
////////////////////////////////////////////////////////////////////////////////
 
104
 
 
105
 
 
106
/**
 
107
 * An immediate transaction.
93
108
 */
94
109
class immediate_transaction
95
110
        :
96
 
        public basic_transaction
 
111
        public detail::basic_transaction
97
112
{
98
113
//______________________________________________________________________________
99
114
//                                                                 instantiation
100
115
public:
101
116
 
102
117
        /**
103
 
         * Constructor that provides a database upon which to act
104
 
         * @param database a database
 
118
         * Constructor that provides a connection upon which to act.
 
119
         *
 
120
         * @param connection a connection
105
121
         */
106
122
        explicit immediate_transaction(
107
 
                database &database );
 
123
                connection &connection );
108
124
 
109
125
//______________________________________________________________________________
110
126
//                                                              public interface
111
127
public:
112
128
 
113
129
        /**
114
 
         * Begin the transaction
 
130
         * Begin the transaction.
115
131
         */
116
132
        virtual void begin();
117
133
 
122
138
 
123
139
 
124
140
/**
125
 
 * An exclusive transaction
 
141
 * An exclusive transaction.
126
142
 */
127
143
class exclusive_transaction
128
144
        :
129
 
        public basic_transaction
 
145
        public detail::basic_transaction
130
146
{
131
147
//______________________________________________________________________________
132
148
//                                                                 instantiation
133
149
public:
134
150
 
135
151
        /**
136
 
         * Constructor that provides a database upon which to act
137
 
         * @param database a database
 
152
         * Constructor that provides a connection upon which to act.
 
153
         *
 
154
         * @param connection a connection
138
155
         */
139
156
        explicit exclusive_transaction(
140
 
                database &database );
 
157
                connection &connection );
141
158
 
142
159
//______________________________________________________________________________
143
160
//                                                              public interface
159
176
 */
160
177
class recursive_transaction
161
178
        :
162
 
        public basic_transaction
 
179
        public detail::basic_transaction
163
180
{
164
181
//______________________________________________________________________________
165
182
//                                                                 instantiation
166
183
public:
167
184
 
168
185
        /**
169
 
         * Constructor that provides a database upon which to act
170
 
         * @param database a database
 
186
         * Constructor that provides a connection upon which to act.
 
187
         *
 
188
         * @param connection a connection
171
189
         */
172
190
        explicit recursive_transaction(
173
 
                database &database );
 
191
                connection &connection );
174
192
 
175
193
//______________________________________________________________________________
176
194
//                                                              public interface
177
195
public:
178
196
 
179
197
        /**
180
 
         * Begin the transaction
 
198
         * Begin the transaction.
181
199
         */
182
200
        virtual void begin();
183
201
 
184
202
        /**
185
 
         * Commit the transaction
 
203
         * Commit the transaction.
186
204
         */
187
205
        virtual void commit();
188
206
 
189
207
        /**
190
 
         * Rollback the transaction
 
208
         * Rollback the transaction.
191
209
         */
192
210
        virtual void rollback();
193
211
 
205
223
 
206
224
 
207
225
/**
208
 
 * A scope guard, or sentinel for use with one of the transaction classes.
 
226
 * A scope guard (sentinel) for use with one of the transaction classes to
 
227
 * provide RAII-style transactions.  It defaults to using deferred transactions.
209
228
 */
210
 
template< class T = basic_transaction >
 
229
template< class T = deferred_transaction >
211
230
class transaction_guard
212
231
        :
213
232
        private boost::noncopyable
217
236
public:
218
237
 
219
238
        /**
220
 
         * Constructor that provides a database upon which to act
221
 
         * @param database a database
 
239
         * Constructor that provides a connection upon which to act.
 
240
         *
 
241
         * @param connection a connection
222
242
         */
223
243
        explicit transaction_guard(
224
 
                database &database )
 
244
                connection &connection )
225
245
                :
226
 
                _transaction( database ),
227
 
                _released( false )
 
246
                _transaction( connection ),
 
247
                _released( true )
228
248
        {
229
249
                _transaction.begin();
 
250
                _released = false;
230
251
        }
231
252
 
232
253
        ~transaction_guard()
233
254
        {
234
 
                if( !_released ) {
235
 
                        try {
236
 
                                _transaction.rollback();
237
 
                        }
238
 
                        catch( ... ) {
239
 
                        }
240
 
                }
 
255
                if( !_released )
 
256
                        _transaction.rollback();
241
257
        }
242
258
 
243
259
//______________________________________________________________________________
245
261
public:
246
262
 
247
263
        /**
248
 
         * Commit the transaction
 
264
         * Begin the transaction. Note that this is done automatically in the
 
265
         * constructor.
 
266
         */
 
267
        void begin()
 
268
        {
 
269
                if( _released ) {
 
270
                        _transaction.begin();
 
271
                        _released = false;
 
272
                }
 
273
        }
 
274
 
 
275
        /**
 
276
         * Commit the transaction.
249
277
         */
250
278
        void commit()
251
279
        {
255
283
                }
256
284
        }
257
285
 
 
286
        /**
 
287
         * Rollback the transaction. Note that this is done automatically in the
 
288
         * destructor if the transaction hasn't otherwise been completed.
 
289
         */
 
290
        void rollback()
 
291
        {
 
292
                if( !_released ) {
 
293
                        _transaction.rollback();
 
294
                        _released = true;
 
295
                }
 
296
        }
 
297
 
258
298
//______________________________________________________________________________
259
299
//                                                                implementation
260
300
protected: