swift
Signals | Public Member Functions | Static Public Member Functions | List of all members
swift::core::db::CBackgroundDataUpdater Class Reference

Update and consolidation of DB data. More...

Inheritance diagram for swift::core::db::CBackgroundDataUpdater:
[legend]

Signals

void consolidating (bool running)
 Consolidation.
 
- Signals inherited from swift::misc::CWorkerBase
void aboutToStart ()
 Emitted when the task is about to start.
 
void finished ()
 Emitted when the task is finished. More...
 

Public Member Functions

 CBackgroundDataUpdater (QObject *owner)
 Constructor.
 
swift::misc::CStatusMessageList getMessageHistory () const
 The message history. More...
 
void startUpdating (std::chrono::milliseconds ms)
 Start the updating timer. More...
 
- Public Member Functions inherited from swift::misc::CContinuousWorker
 CContinuousWorker (QObject *owner, const QString &name)
 Constructor. More...
 
void start (QThread::Priority priority=QThread::InheritPriority)
 Starts a thread and moves the worker into it.
 
void quit () noexcept final
 Stops the thread the next time around its event loop. The thread and the worker will then be deleted. More...
 
void quitAndWait () noexcept final
 Calls quit() and blocks until the thread is finished. More...
 
bool isEnabled () const
 Enabled (running)? More...
 
const QString & getName ()
 Name of the worker.
 
const QObject * owner () const
 Owner of the worker.
 
- Public Member Functions inherited from swift::misc::CWorkerBase
 ~CWorkerBase ()
 Destructor.
 
 CWorkerBase (const CWorkerBase &)=delete
 Copy constructor.
 
CWorkerBaseoperator= (const CWorkerBase &)=delete
 Copy assignment.
 
 CWorkerBase (CWorkerBase &&)=delete
 Move constructor.
 
CWorkerBaseoperator= (CWorkerBase &&)=delete
 Move assignment.
 
template<typename T , typename F >
void then (T *context, F functor)
 Connects to a functor or method which will be called when the task is finished. More...
 
template<typename F >
void then (F functor)
 Connects to a functor which will be called when the task is finished. More...
 
bool isFinished () const
 Returns true if the task has finished. More...
 
template<typename F >
void doIfFinished (F functor) const
 Executes some code (in the caller's thread) if the task has finished. More...
 
template<typename F >
void doIfNotFinished (F functor) const
 Executes some code (in the caller's thread) if the task has not finished. More...
 
template<typename F1 , typename F2 >
void doIfFinishedElse (F1 ifFunctor, F2 elseFunctor) const
 Executes some code (in the caller's thread) if the task has finished and some different code if it has not finished. More...
 
void waitForFinished () noexcept
 Blocks until the task is finished. More...
 
void abandon () noexcept
 Notify the task that its result is no longer needed, so it can finish early. More...
 
void abandonAndWait () noexcept
 Convenience to call abandon() followed by waitForFinished().
 

Static Public Member Functions

static const QStringList & getLogCategories ()
 Log categories.
 
- Static Public Member Functions inherited from swift::misc::CWorkerBase
static const QStringList & getLogCategories ()
 Log categories.
 
static const QSet< CWorkerBase * > & allWorkers ()
 All workers currently existing.
 

Additional Inherited Members

- Protected Member Functions inherited from swift::misc::CContinuousWorker
virtual void initialize ()
 Called when the thread is started.
 
virtual void cleanup ()
 Called when the thread is finished.
 
virtual void beforeQuit () noexcept
 Called before quit is called. More...
 
virtual unsigned long waitTimeoutMs () const
 Wait time for quitAndWait, 0 means not waiting.
 
- Protected Member Functions inherited from swift::misc::CWorkerBase
 CWorkerBase ()
 Constructor.
 
bool isAbandoned () const
 For the task to check whether it can finish early. More...
 
bool hasStarted () const
 True if the worker has started.
 
void setStarted ()
 Mark the task as started.
 
void setFinished ()
 Mark the task as finished.
 

Detailed Description

Update and consolidation of DB data.

Definition at line 25 of file backgrounddataupdater.h.

Member Function Documentation

◆ getMessageHistory()

CStatusMessageList swift::core::db::CBackgroundDataUpdater::getMessageHistory ( ) const

The message history.

Remarks
This function is thread safe.

Definition at line 44 of file backgrounddataupdater.cpp.

◆ startUpdating()

void swift::core::db::CBackgroundDataUpdater::startUpdating ( std::chrono::milliseconds  ms)

Start the updating timer.

Remarks
This function is thread safe.

Definition at line 50 of file backgrounddataupdater.cpp.


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