A C++ interface towards an SQLITE database. More...

#include "sqlite-output.h"

Inheritance diagram for ns3::SQLiteOutput:

Collaboration diagram for ns3::SQLiteOutput:

Public Member Functions
	SQLiteOutput (const std::string &name)
	SQLiteOutput constructor. More...

	~SQLiteOutput ()
	Destructor. More...

template<typename T >
bool	Bind ([[maybe_unused]] sqlite3_stmt *stmt, [[maybe_unused]] int pos, [[maybe_unused]] const T &value) const

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const double &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const int &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const long &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const long long &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const std::string &value) const
	Bind a value to a sqlite statement. More...

template<typename T >
bool	Bind (sqlite3_stmt *stmt, int pos, const T &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const Time &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const uint16_t &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const uint32_t &value) const
	Bind a value to a sqlite statement. More...

template<>
bool	Bind (sqlite3_stmt *stmt, int pos, const uint8_t &value) const
	Bind a value to a sqlite statement. More...

template<typename T >
T	RetrieveColumn ([[maybe_unused]] sqlite3_stmt *stmt, [[maybe_unused]] int pos) const

template<>
int	RetrieveColumn (sqlite3_stmt *stmt, int pos) const
	Retrieve a value from an executed statement. More...

template<typename T >
T	RetrieveColumn (sqlite3_stmt *stmt, int pos) const
	Retrieve a value from an executed statement. More...

void	SetJournalInMemory ()
	Instruct SQLite to store the journal in memory. More...

bool	SpinExec (const std::string &cmd) const
	Execute a command until the return value is OK or an ERROR. More...

bool	SpinExec (sqlite3_stmt *stmt) const
	Execute a command until the return value is OK or an ERROR. More...

bool	SpinPrepare (sqlite3_stmt **stmt, const std::string &cmd) const
	Prepare a statement. More...

bool	WaitExec (const std::string &cmd) const
	Execute a command, waiting on a mutex. More...

bool	WaitExec (sqlite3_stmt *stmt) const
	Execute a command, waiting on a mutex. More...

bool	WaitPrepare (sqlite3_stmt **stmt, const std::string &cmd) const
	Prepare a statement, waiting on a mutex. More...

Public Member Functions inherited from ns3::SimpleRefCount< SQLiteOutput >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Static Public Member Functions
static int	SpinFinalize (sqlite3_stmt *stmt)
	Finalize a statement until the result is ok or an error. More...

static int	SpinReset (sqlite3_stmt *stmt)
	Reset a statement until the result is ok or an error. More...

static int	SpinStep (sqlite3_stmt *stmt)
	Execute a step operation on a statement until the result is ok or an error. More...

Protected Member Functions
int	WaitExec (sqlite3 *db, const std::string &cmd) const
	Execute a command, waiting on a mutex. More...

int	WaitExec (sqlite3 db, sqlite3_stmt stmt) const
	Execute a statement, waiting on a mutex. More...

int	WaitPrepare (sqlite3 db, sqlite3_stmt *stmt, const std::string &cmd) const
	Prepare a statement, waiting on a mutex. More...

Static Protected Member Functions
static bool	CheckError (sqlite3 *db, int rc, const std::string &cmd, bool hardExit)
	Check any error in the db. More...

static void	Error (sqlite3 *db, const std::string &cmd)
	Fail, printing an error message from sqlite. More...

static int	SpinExec (sqlite3 *db, const std::string &cmd)
	Execute a command ignoring concurrency problems, retrying instead. More...

static int	SpinExec (sqlite3 db, sqlite3_stmt stmt)
	Execute a Prepared Statement Object ignoring concurrency problems, retrying instead. More...

static int	SpinPrepare (sqlite3 db, sqlite3_stmt *stmt, const std::string &cmd)
	Preparing a command ignoring concurrency problems, retrying instead. More...

Private Attributes
sqlite3 *	m_db
	Database pointer. More...

std::string	m_dBname
	Database name. More...

std::mutex	m_mutex
	Mutex. More...

Detailed Description

A C++ interface towards an SQLITE database.

The class is able to execute commands, and retrieve results, from an SQLITE database. The methods with the "Spin" prefix, in case of concurrent access to the database, will spin until the operation is applied. The methods with the "Wait" prefix will wait on a mutex.

If you run multiple simulations that write on the same database, it is recommended to use the "Wait" prefixed methods. Otherwise, if the access to the database is unique, using "Spin" methods will speed up database access.

The database is opened in the constructor, and closed in the deconstructor.

Definition at line 45 of file sqlite-output.h.

Constructor & Destructor Documentation

◆ SQLiteOutput()

ns3::SQLiteOutput::SQLiteOutput ( const std::string & name )

SQLiteOutput constructor.

Parameters

name	database name

Definition at line 30 of file sqlite-output.cc.

References m_db, and NS_ABORT_MSG_UNLESS.

◆ ~SQLiteOutput()

ns3::SQLiteOutput::~SQLiteOutput ( )

Destructor.

Definition at line 36 of file sqlite-output.cc.

References m_db, and NS_ABORT_MSG_UNLESS.

Member Function Documentation

◆ Bind() [1/11]

template<typename T >

bool ns3::SQLiteOutput::Bind	(	[[maybe_unused] ] sqlite3_stmt *	stmt,
		[[maybe_unused] ] int	pos,
		[[maybe_unused] ] const T &	value
	)		const

Definition at line 122 of file sqlite-output.cc.

References NS_FATAL_ERROR.

◆ Bind() [2/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const double &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 143 of file sqlite-output.cc.

◆ Bind() [3/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const int &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 215 of file sqlite-output.cc.

◆ Bind() [4/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const long &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 167 of file sqlite-output.cc.

◆ Bind() [5/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const long long &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 179 of file sqlite-output.cc.

◆ Bind() [6/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const std::string &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 227 of file sqlite-output.cc.

◆ Bind() [7/11]

template<typename T >

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const T &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

◆ Bind() [8/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const Time &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 131 of file sqlite-output.cc.

◆ Bind() [9/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const uint16_t &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 191 of file sqlite-output.cc.

◆ Bind() [10/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const uint32_t &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 155 of file sqlite-output.cc.

◆ Bind() [11/11]

template<>

bool ns3::SQLiteOutput::Bind	(	sqlite3_stmt *	stmt,
		int	pos,
		const uint8_t &	value
	)		const

Bind a value to a sqlite statement.

Parameters

stmt	Sqlite statement
pos	Position of the bind argument inside the statement
value	Value to bind

Returns: true on success, false otherwise

Definition at line 203 of file sqlite-output.cc.

◆ CheckError()

bool ns3::SQLiteOutput::CheckError	(	sqlite3 *	db,
		int	rc,
		const std::string &	cmd,
		bool	hardExit
	)

staticprotected

Check any error in the db.

Parameters

db	Database
rc	Sqlite return code
cmd	Command
hardExit	if true, will exit the program

Returns: true in case of error, false otherwise

Definition at line 318 of file sqlite-output.cc.

References second::cmd, and Error().

Referenced by SpinExec(), WaitExec(), and WaitPrepare().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Error()

void ns3::SQLiteOutput::Error	(	sqlite3 *	db,
		const std::string &	cmd
	)

staticprotected

Fail, printing an error message from sqlite.

Parameters

db	Database
cmd	Command

Definition at line 312 of file sqlite-output.cc.

References second::cmd, and NS_ABORT_MSG.

Referenced by CheckError().

Here is the caller graph for this function:

◆ RetrieveColumn() [1/3]

template<typename T >

T ns3::SQLiteOutput::RetrieveColumn	(	[[maybe_unused] ] sqlite3_stmt *	stmt,
		[[maybe_unused] ] int	pos
	)		const

Definition at line 91 of file sqlite-output.cc.

References NS_FATAL_ERROR.

◆ RetrieveColumn() [2/3]

template<>

double ns3::SQLiteOutput::RetrieveColumn	(	sqlite3_stmt *	stmt,
		int	pos
	)		const

Retrieve a value from an executed statement.

Parameters

stmt	sqlite statement
pos	Column position

Returns: the value from the executed statement

Definition at line 99 of file sqlite-output.cc.

◆ RetrieveColumn() [3/3]

template<typename T >

T ns3::SQLiteOutput::RetrieveColumn	(	sqlite3_stmt *	stmt,
		int	pos
	)		const

Retrieve a value from an executed statement.

Parameters

stmt	sqlite statement
pos	Column position

Returns: the value from the executed statement

◆ SetJournalInMemory()

void ns3::SQLiteOutput::SetJournalInMemory ( )

Instruct SQLite to store the journal in memory.

May lead to data losses in case of unexpected program exits.

Definition at line 45 of file sqlite-output.cc.

References NS_LOG_FUNCTION, and SpinExec().

Here is the call graph for this function:

◆ SpinExec() [1/4]

bool ns3::SQLiteOutput::SpinExec ( const std::string & cmd ) const

Execute a command until the return value is OK or an ERROR.

Ignore errors due to concurrency, the method will repeat the command instead

Parameters

cmd Command

Returns: true in case of success

Definition at line 52 of file sqlite-output.cc.

References second::cmd, and m_db.

Referenced by SetJournalInMemory(), and SpinExec().

Here is the caller graph for this function:

◆ SpinExec() [2/4]

int ns3::SQLiteOutput::SpinExec	(	sqlite3 *	db,
		const std::string &	cmd
	)

staticprotected

Execute a command ignoring concurrency problems, retrying instead.

Parameters

db	Database
cmd	Command

Returns: Sqlite error code

Definition at line 337 of file sqlite-output.cc.

References CheckError(), second::cmd, SpinFinalize(), SpinPrepare(), and SpinStep().

Here is the call graph for this function:

◆ SpinExec() [3/4]

int ns3::SQLiteOutput::SpinExec	(	sqlite3 *	db,
		sqlite3_stmt *	stmt
	)

staticprotected

Execute a Prepared Statement Object ignoring concurrency problems, retrying instead.

Parameters

db	Database
stmt	Prepared Statement Object

Returns: Sqlite error code

Definition at line 363 of file sqlite-output.cc.

References CheckError(), SpinFinalize(), and SpinStep().

Here is the call graph for this function:

◆ SpinExec() [4/4]

bool ns3::SQLiteOutput::SpinExec ( sqlite3_stmt * stmt ) const

Execute a command until the return value is OK or an ERROR.

Parameters

stmt	SQLite statement

Returns: true in case of success

Definition at line 58 of file sqlite-output.cc.

References CheckError(), m_db, and SpinExec().

Here is the call graph for this function:

◆ SpinFinalize()

int ns3::SQLiteOutput::SpinFinalize ( sqlite3_stmt * stmt )

static

Finalize a statement until the result is ok or an error.

Ignores concurrency errors; it will retry instead of failing.

Parameters

stmt Statement

Returns: Sqlite error code

Definition at line 286 of file sqlite-output.cc.

Referenced by SpinExec(), and WaitExec().

Here is the caller graph for this function:

◆ SpinPrepare() [1/2]

int ns3::SQLiteOutput::SpinPrepare	(	sqlite3 *	db,
		sqlite3_stmt **	stmt,
		const std::string &	cmd
	)

staticprotected

Preparing a command ignoring concurrency problems, retrying instead.

Parameters

db	Database
stmt	Statement
cmd	Command to prepare

Returns: Sqlite error code

Definition at line 258 of file sqlite-output.cc.

References second::cmd.

◆ SpinPrepare() [2/2]

bool ns3::SQLiteOutput::SpinPrepare	(	sqlite3_stmt **	stmt,
		const std::string &	cmd
	)		const

Prepare a statement.

Parameters

stmt	Sqlite statement
cmd	Command to prepare inside the statement

Returns: true in case of success

Definition at line 84 of file sqlite-output.cc.

References second::cmd, and m_db.

Referenced by SpinExec(), and WaitExec().

Here is the caller graph for this function:

◆ SpinReset()

int ns3::SQLiteOutput::SpinReset ( sqlite3_stmt * stmt )

static

Reset a statement until the result is ok or an error.

Ignores concurrency errors: it will retry instead of failing.

Parameters

stmt Statement

Returns: the return code of reset

Definition at line 298 of file sqlite-output.cc.

◆ SpinStep()

int ns3::SQLiteOutput::SpinStep ( sqlite3_stmt * stmt )

static

Execute a step operation on a statement until the result is ok or an error.

Ignores concurrency errors; it will retry instead of failing.

Parameters

stmt Statement

Returns: Sqlite error core

Definition at line 273 of file sqlite-output.cc.

Referenced by SpinExec(), and WaitExec().

Here is the caller graph for this function:

◆ WaitExec() [1/4]

bool ns3::SQLiteOutput::WaitExec ( const std::string & cmd ) const

Execute a command, waiting on a mutex.

Parameters

cmd	Command to be executed

Returns: true in case of success

Definition at line 65 of file sqlite-output.cc.

References CheckError(), second::cmd, and m_db.

Referenced by WaitExec().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WaitExec() [2/4]

int ns3::SQLiteOutput::WaitExec	(	sqlite3 *	db,
		const std::string &	cmd
	)		const

protected

Execute a command, waiting on a mutex.

Parameters

db	Database
cmd	Command

Returns: Sqlite error code

Definition at line 399 of file sqlite-output.cc.

References CheckError(), second::cmd, m_mutex, SpinFinalize(), SpinPrepare(), and SpinStep().

Here is the call graph for this function:

◆ WaitExec() [3/4]

int ns3::SQLiteOutput::WaitExec	(	sqlite3 *	db,
		sqlite3_stmt *	stmt
	)		const

protected

Execute a statement, waiting on a mutex.

Parameters

db	Database
stmt	Statement

Returns: Sqlite error code

Definition at line 378 of file sqlite-output.cc.

References CheckError(), m_mutex, SpinFinalize(), and SpinStep().

Here is the call graph for this function:

◆ WaitExec() [4/4]

bool ns3::SQLiteOutput::WaitExec ( sqlite3_stmt * stmt ) const

Execute a command, waiting on a mutex.

Parameters

stmt	Sqlite3 statement to be executed

Returns: true in case of success

Definition at line 72 of file sqlite-output.cc.

References m_db, and WaitExec().

Here is the call graph for this function:

◆ WaitPrepare() [1/2]

int ns3::SQLiteOutput::WaitPrepare	(	sqlite3 *	db,
		sqlite3_stmt **	stmt,
		const std::string &	cmd
	)		const

protected

Prepare a statement, waiting on a mutex.

Parameters

db	Database
stmt	Statement
cmd	Command to prepare

Returns: Sqlite error code

Definition at line 237 of file sqlite-output.cc.

References CheckError(), second::cmd, and m_mutex.

Here is the call graph for this function:

◆ WaitPrepare() [2/2]

bool ns3::SQLiteOutput::WaitPrepare	(	sqlite3_stmt **	stmt,
		const std::string &	cmd
	)		const

Prepare a statement, waiting on a mutex.

Parameters

stmt	Sqlite statement
cmd	Command to prepare inside the statement

Returns: true in case of success

Definition at line 78 of file sqlite-output.cc.

References second::cmd, and m_db.

Member Data Documentation

◆ m_db

sqlite3* ns3::SQLiteOutput::m_db

private

Initial value:

{
    nullptr
  }

Database pointer.

Definition at line 232 of file sqlite-output.h.

Referenced by SQLiteOutput(), ~SQLiteOutput(), SpinExec(), SpinPrepare(), WaitExec(), and WaitPrepare().

◆ m_dBname

std::string ns3::SQLiteOutput::m_dBname

private

Database name.

Definition at line 230 of file sqlite-output.h.

◆ m_mutex

std::mutex ns3::SQLiteOutput::m_mutex

mutableprivate

Mutex.

Definition at line 231 of file sqlite-output.h.

Referenced by WaitExec(), and WaitPrepare().

The documentation for this class was generated from the following files:

src/stats/model/sqlite-output.h
src/stats/model/sqlite-output.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SQLiteOutput()

◆ ~SQLiteOutput()

Member Function Documentation

◆ Bind() [1/11]

◆ Bind() [2/11]

◆ Bind() [3/11]

◆ Bind() [4/11]

◆ Bind() [5/11]

◆ Bind() [6/11]

◆ Bind() [7/11]

◆ Bind() [8/11]

◆ Bind() [9/11]

◆ Bind() [10/11]

◆ Bind() [11/11]

◆ CheckError()

◆ Error()

◆ RetrieveColumn() [1/3]

◆ RetrieveColumn() [2/3]

◆ RetrieveColumn() [3/3]

◆ SetJournalInMemory()

◆ SpinExec() [1/4]

◆ SpinExec() [2/4]

◆ SpinExec() [3/4]

◆ SpinExec() [4/4]

◆ SpinFinalize()

◆ SpinPrepare() [1/2]

◆ SpinPrepare() [2/2]

◆ SpinReset()

◆ SpinStep()

◆ WaitExec() [1/4]

◆ WaitExec() [2/4]

◆ WaitExec() [3/4]

◆ WaitExec() [4/4]

◆ WaitPrepare() [1/2]

◆ WaitPrepare() [2/2]

Member Data Documentation

◆ m_db

◆ m_dBname

◆ m_mutex