A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
sqlite-output.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 Natale Patriciello <natale.patriciello@gmail.com>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 */
18#ifndef SQLITE_OUTPUT_H
19#define SQLITE_OUTPUT_H
20
21#include "ns3/simple-ref-count.h"
22
23#include <mutex>
24#include <sqlite3.h>
25#include <string>
26
27namespace ns3
28{
29
46class SQLiteOutput : public SimpleRefCount<SQLiteOutput>
47{
48 public:
53 SQLiteOutput(const std::string& name);
54
59
64 void SetJournalInMemory();
65
74 bool SpinExec(const std::string& cmd) const;
75
81 bool SpinExec(sqlite3_stmt* stmt) const;
82
88 bool WaitExec(const std::string& cmd) const;
89
95 bool WaitExec(sqlite3_stmt* stmt) const;
96
103 bool WaitPrepare(sqlite3_stmt** stmt, const std::string& cmd) const;
104
111 bool SpinPrepare(sqlite3_stmt** stmt, const std::string& cmd) const;
112
120 template <typename T>
121 bool Bind(sqlite3_stmt* stmt, int pos, const T& value) const;
122
129 template <typename T>
130 T RetrieveColumn(sqlite3_stmt* stmt, int pos) const;
131
141 static int SpinStep(sqlite3_stmt* stmt);
150 static int SpinFinalize(sqlite3_stmt* stmt);
151
159 static int SpinReset(sqlite3_stmt* stmt);
160
161 protected:
168 int WaitExec(sqlite3* db, const std::string& cmd) const;
169
176 int WaitExec(sqlite3* db, sqlite3_stmt* stmt) const;
177
185 int WaitPrepare(sqlite3* db, sqlite3_stmt** stmt, const std::string& cmd) const;
186
193 static int SpinExec(sqlite3* db, const std::string& cmd);
194
201 static int SpinExec(sqlite3* db, sqlite3_stmt* stmt);
202
210 static int SpinPrepare(sqlite3* db, sqlite3_stmt** stmt, const std::string& cmd);
211
217 [[noreturn]] static void Error(sqlite3* db, const std::string& cmd);
218
227 static bool CheckError(sqlite3* db, int rc, const std::string& cmd, bool hardExit);
228
229 private:
230 std::string m_dBname;
231 mutable std::mutex m_mutex;
232 sqlite3* m_db{nullptr};
233};
234
235} // namespace ns3
236#endif
A C++ interface towards an SQLITE database.
Definition: sqlite-output.h:47
sqlite3 * m_db
Database pointer.
std::string m_dBname
Database name.
bool SpinExec(const std::string &cmd) const
Execute a command until the return value is OK or an ERROR.
static bool CheckError(sqlite3 *db, int rc, const std::string &cmd, bool hardExit)
Check any error in the db.
~SQLiteOutput()
Destructor.
static int SpinStep(sqlite3_stmt *stmt)
Execute a step operation on a statement until the result is ok or an error.
void SetJournalInMemory()
Instruct SQLite to store the journal in memory.
T RetrieveColumn(sqlite3_stmt *stmt, int pos) const
Retrieve a value from an executed statement.
bool Bind(sqlite3_stmt *stmt, int pos, const T &value) const
Bind a value to a sqlite statement.
static int SpinReset(sqlite3_stmt *stmt)
Reset a statement until the result is ok or an error.
static int SpinFinalize(sqlite3_stmt *stmt)
Finalize a statement until the result is ok or an error.
std::mutex m_mutex
Mutex.
bool WaitExec(const std::string &cmd) const
Execute a command, waiting on a mutex.
static void Error(sqlite3 *db, const std::string &cmd)
Fail, printing an error message from sqlite.
bool SpinPrepare(sqlite3_stmt **stmt, const std::string &cmd) const
Prepare a statement.
bool WaitPrepare(sqlite3_stmt **stmt, const std::string &cmd) const
Prepare a statement, waiting on a mutex.
A template-based reference counting class.
Every class exported by the ns3 library is enclosed in the ns3 namespace.