A Discrete-Event Network Simulator
API
sqlite-output.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2018 Natale Patriciello <natale.patriciello@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 */
19#ifndef SQLITE_OUTPUT_H
20#define SQLITE_OUTPUT_H
21
22#include "ns3/simple-ref-count.h"
23#include <sqlite3.h>
24#include <string>
25#include <semaphore.h>
26
27namespace ns3 {
28
45class SQLiteOutput : public SimpleRefCount <SQLiteOutput>
46{
47public:
53 SQLiteOutput (const std::string &name, const std::string &semName);
58
63 void SetJournalInMemory ();
64
73 bool SpinExec (const std::string &cmd) const;
74
80 bool SpinExec (sqlite3_stmt *stmt) const;
86 bool WaitExec (const std::string &cmd) const;
87
93 bool WaitExec (sqlite3_stmt *stmt) const;
94
101 bool WaitPrepare (sqlite3_stmt **stmt, const std::string &cmd) const;
102
109 bool SpinPrepare (sqlite3_stmt **stmt, const std::string &cmd) const;
110
118 template<typename T>
119 bool Bind (sqlite3_stmt *stmt, int pos, const T &value) const;
120
127 template<typename T>
128 T RetrieveColumn (sqlite3_stmt *stmt, int pos) const;
129
138 static int SpinStep (sqlite3_stmt *stmt);
147 static int SpinFinalize (sqlite3_stmt *stmt);
148
156 static int SpinReset (sqlite3_stmt *stmt);
157
158protected:
165 int WaitExec (sqlite3 *db, const std::string &cmd) const;
172 int WaitExec (sqlite3 *db, sqlite3_stmt *stmt) const;
180 int WaitPrepare (sqlite3 *db, sqlite3_stmt **stmt, const std::string &cmd) const;
181
188 static int SpinExec (sqlite3 *db, const std::string &cmd);
189
196 static int SpinExec (sqlite3 *db, sqlite3_stmt *stmt);
197
205 static int SpinPrepare (sqlite3 *db, sqlite3_stmt **stmt, const std::string &cmd);
206
212 [[ noreturn ]] static void Error (sqlite3 *db, const std::string &cmd);
222 static bool CheckError (sqlite3 *db, int rc, const std::string &cmd,
223 sem_t *sem, bool hardExit);
224
225private:
226 std::string m_dBname;
227 std::string m_semName;
228 sqlite3 *m_db {
229 nullptr
230 };
231};
232
233} // namespace ns3
234#endif
A C++ interface towards an SQLITE database.
Definition: sqlite-output.h:46
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.
~SQLiteOutput()
Destructor.
static bool CheckError(sqlite3 *db, int rc, const std::string &cmd, sem_t *sem, bool hardExit)
Check any error in the db.
static int SpinStep(sqlite3_stmt *stmt)
Execute a step operation on a statement until the result is ok or an error.
SQLiteOutput(const std::string &name, const std::string &semName)
SQLiteOutput constructor.
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.
std::string m_semName
System semaphore name.
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.
bool WaitExec(const std::string &cmd) const
Execute a command, waiting on a system semaphore.
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 system semaphore.
A template-based reference counting class.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
cmd
Definition: second.py:35