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 
27 namespace ns3 {
28 
45 class SQLiteOutput : public SimpleRefCount <SQLiteOutput>
46 {
47 public:
53  SQLiteOutput (const std::string &name, const std::string &semName);
57  ~SQLiteOutput ();
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 
117  template<typename T>
118  bool Bind (sqlite3_stmt *stmt, int pos, const T &value) const;
119 
125  template<typename T>
126  T RetrieveColumn (sqlite3_stmt *stmt, int pos) const;
127 
136  static int SpinStep (sqlite3_stmt *stmt);
145  static int SpinFinalize (sqlite3_stmt *stmt);
146 
154  static int SpinReset (sqlite3_stmt *stmt);
155 
156 protected:
163  int WaitExec (sqlite3 *db, const std::string &cmd) const;
170  int WaitExec (sqlite3 *db, sqlite3_stmt *stmt) const;
178  int WaitPrepare (sqlite3 *db, sqlite3_stmt **stmt, const std::string &cmd) const;
179 
186  static int SpinExec (sqlite3 *db, const std::string &cmd);
187 
188  static int SpinExec (sqlite3 *db, sqlite3_stmt *stmt);
196  static int SpinPrepare (sqlite3 *db, sqlite3_stmt **stmt, const std::string &cmd);
197 
203  [[ noreturn ]] static void Error (sqlite3 *db, const std::string &cmd);
213  static bool CheckError (sqlite3 *db, int rc, const std::string &cmd,
214  sem_t *sem, bool hardExit);
215 
216 private:
217  std::string m_dBname;
218  std::string m_semName;
219  sqlite3 *m_db {
220  nullptr
221  };
222 };
223 
224 } // namespace ns3
225 #endif
static bool CheckError(sqlite3 *db, int rc, const std::string &cmd, sem_t *sem, bool hardExit)
Check any error in the db.
A C++ interface towards an SQLITE database.
Definition: sqlite-output.h:45
static void Error(sqlite3 *db, const std::string &cmd)
Fail, printing an error message from sqlite.
SQLiteOutput(const std::string &name, const std::string &semName)
SQLiteOutput constructor.
bool SpinExec(const std::string &cmd) const
Execute a command until the return value is OK or an ERROR.
cmd
Definition: second.py:35
void SetJournalInMemory()
Instruct SQLite to store the journal in memory.
static int SpinStep(sqlite3_stmt *stmt)
Execute a step operation on a statement until the result is ok or an error.
std::string m_semName
System semaphore name.
static int SpinFinalize(sqlite3_stmt *stmt)
Finalize a statement until the result is ok or an error.
bool WaitPrepare(sqlite3_stmt **stmt, const std::string &cmd) const
Prepare a statement, waiting on a system semaphore.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool SpinPrepare(sqlite3_stmt **stmt, const std::string &cmd) const
Prepare a statement.
T RetrieveColumn(sqlite3_stmt *stmt, int pos) const
Retrieve a value from an executed statement.
~SQLiteOutput()
Destructor.
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.
sqlite3 * m_db
Database pointer.
bool WaitExec(const std::string &cmd) const
Execute a command, waiting on a system semaphore.
std::string m_dBname
Database name.
A template-based reference counting class.