Class QgsGpkgFlusher

ClassList > QgsGpkgFlusher

More...

• #include <qgsgpkgflusher.h>

Inherits the following classes: QObject

Public Signals

Type	Name
signal void	requestFlush (const QString & filename)

Public Functions

Type	Name
	QgsGpkgFlusher (QgsProject * project)
bool	isStopped (const QString & fileName) const
void	start (const QString & fileName)
void	stop (const QString & fileName)
	~QgsGpkgFlusher ()

Detailed Description

The QgsGpkgFlusher class is attached to a QgsProject. It will make sure that all changes are regularly flushed from the wal file to the gpkg itself on all added layers. It will start a background thread and post an event to it whenever the gpkg has been changed. After a delay of 500ms without any changes the wal file will be flushed. The flusher does not need to be started after initialization.

Public Signals Documentation

signal requestFlush

void QgsGpkgFlusher::requestFlush;

Emitted when a file has changed and a flush should be scheduled.

---

Public Functions Documentation

function QgsGpkgFlusher

explicit QgsGpkgFlusher::QgsGpkgFlusher (
    QgsProject * project
) 

---

function isStopped

bool QgsGpkgFlusher::isStopped (
    const QString & fileName
) const

Returns whether the flusher is stopped for a given fileName

---

function start

void QgsGpkgFlusher::start (
    const QString & fileName
) 

Reenables scheduling a flush for a given fileName.

---

function stop

void QgsGpkgFlusher::stop (
    const QString & fileName
) 

Immediately performs a flush for a given fileName and returns. If the flusher is stopped, flush for that fileName would be ignored.

---

function ~QgsGpkgFlusher

QgsGpkgFlusher::~QgsGpkgFlusher () 

---

---

The documentation for this class was generated from the following file src/core/qgsgpkgflusher.h