dca_interface  6.3.4
customdb_samples/customdbsample_extended/perform_update_thread.h File Reference

Header file for the update thread. More...

Go to the source code of this file.

Functions

void createPerformUpdateThread (const dca::UpdateModule &aUpdateModule, volatile bool *errorSignal)
 Starts up the update thread and supply the given UpdateModule. More...
 
void shutdownPerformUpdateThread ()
 Shuts down the previously started update thread. More...
 

Detailed Description

Header file for the update thread.

Definition in file customdb_samples/customdbsample_extended/perform_update_thread.h.

Function Documentation

◆ createPerformUpdateThread()

void createPerformUpdateThread ( const dca::UpdateModule aUpdateModule,
volatile bool *  errorSignal 
)

Starts up the update thread and supply the given UpdateModule.

Parameters
[in]aUpdateModuleAn initialized UpdateModule
[out]errorSignalError signal that is set to true, if an error occured in the call to performUpdate()

Starts up an update thread that calls the aUpdateModule::performUpdate() method in a loop.

The called function will check engine and content updates automatically and install them in the provided dca/init directory.

It can be stopped by a call to shutdownPerformUpdateThread

Note
There are separate implementations for Windows and Linux distributions.
See also
shutdownPerformUpdateThread

Definition at line 63 of file customdb_samples/customdbsample_extended/linux/perform_update_thread.cpp.

◆ shutdownPerformUpdateThread()

void shutdownPerformUpdateThread ( )

Shuts down the previously started update thread.

Shutting down will stop the thread safely.

If an update is already in progress the function will return as soon as possible but will not force-terminate the thread.

Note
To force any running update processes to stop immediately a call to DcaInstance::signal() should be invoked.
There are separate implementations for Windows and Linux distributions.
See also
createPerformUpdateThread

Definition at line 71 of file customdb_samples/customdbsample_extended/linux/perform_update_thread.cpp.