/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/connection.h

  • Committer: edam
  • Date: 2012-01-23 13:51:26 UTC
  • Revision ID: edam@waxworlds.org-20120123135126-7gohm0mv9qwismla
typo

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/connection.h
1
1
/*
2
2
 * connection.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
5
5
 *
6
6
 * This file is part of sqlite3cc (hereafter referred to as "this program").
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.
 
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.
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/>.
55
55
        public:
56
56
 
57
57
                /**
58
 
                 * Constructor that provides a connection upon which to act.
59
 
                 *
 
58
                 * Constructor that provides a connection upon which to act
60
59
                 * @param connection reference to a connection
61
60
                 * @see sqlite3_db_mutex()
62
61
                 * @see sqlite3_mutex_enter()
67
66
                ~mutex_guard();
68
67
 
69
68
                /**
70
 
                 * Release the mutex early.
71
 
                 *
 
69
                 * Release the mutex early
72
70
                 * @see sqlite3_mutex_leave()
73
71
                 */
74
72
                void leave();
83
81
 
84
82
        /**
85
83
         * Constructor that specifies the filename of a database to open.
86
 
         *
87
84
         * @param filename the filename of the database file to open
88
85
         * @throws database_error on error
89
86
         */
99
96
 
100
97
        /**
101
98
         * Open a database.
102
 
         *
103
99
         * @param filename the filename of the database file to open
104
100
         * @param flags flags appropriate for sqlite3_open_v2()
105
101
         * @returns an sqlite error code
111
107
 
112
108
        /**
113
109
         * Close an open database.
114
 
         *
115
110
         * @throws database_error on error
116
111
         * @see sqlite3_close()
117
112
         */
118
113
        void close();
119
114
 
120
115
        /**
121
 
         * Execute an SQL statement.  An exception is thrown on error.
122
 
         *
 
116
         * Execute an SQL statement. An exception is thrown on error.
123
117
         * @param sql an SQL statement in UTF-8
124
118
         * @see sqlite3_exc()
125
119
         */
127
121
                const std::string &sql );
128
122
 
129
123
        /**
130
 
         * Sets a default busy handler which will wait for the specified number of
131
 
         * milliseconds.
132
 
         *
 
124
         * Sets a default busy handler which will
 
125
         * wait for the specified number of milliseconds.
133
126
         * @param duration number of milliseconds to wait
134
127
         * @returns an sqlite error code
135
128
         * @see sqlite3_busy_timeout()