Add comments to startup processes

Atlante45 committed 8 years ago

Commit 2a204531 parent 800d15b5 files · +56 −18Browse files

Showing the changes to libraries/shared/src/SettingInterface.cpp (1 of 5 files). Show all

Unified · Split

libraries/shared/src/SettingInterface.cpp+19−12

 #include "SharedUtil.h"
 namespace Setting {
-    // cleans up the settings private instance. Should only be run once at closing down.
+    // This should only run as a post-routine in the QCoreApplication destructor
-    void cleanupPrivateInstance() {
+    void cleanupSettingsSaveThread() {
         auto globalManager = DependencyManager::get<Manager>();
         Q_ASSERT(qApp && globalManager);
-        // grab the thread before we nuke the instance
+        // Grab the settings thread to shut it down
         QThread* settingsManagerThread = globalManager->thread();
-        // quit the settings manager thread
+        // Quit the settings manager thread and wait for it so we
+        // don't get concurrent accesses when we save all settings below
         settingsManagerThread->quit();
         settingsManagerThread->wait();
-        // Save all settings
+        // [IMPORTANT] Save all settings when the QApplication goes down
         globalManager->saveAll();
         qCDebug(shared) << "Settings thread stopped.";
     }
-    void setupPrivateInstance() {
+    // This should only run as a pre-routine in the QCoreApplication constructor
+    void setupSettingsSaveThread() {
         auto globalManager = DependencyManager::get<Manager>();
         Q_ASSERT(qApp && globalManager);
         QObject::connect(thread, &QThread::finished, globalManager.data(), &Manager::stopTimer);
         // Setup manager threading affinity
+        // This makes the timer fire on the settings thread so we don't block the main
+        // thread with a lot of file I/O.
+        // We bring back the manager to the main thread when the QApplication goes down
         globalManager->moveToThread(thread);
         QObject::connect(thread, &QThread::finished, globalManager.data(), [] {
             auto globalManager = DependencyManager::get<Manager>();
             // Move manager back to the main thread (has to be done on owning thread)
             globalManager->moveToThread(qApp->thread());
         });
+        // Start the settings save thread
         thread->start();
         qCDebug(shared) << "Settings thread started.";
-        // Register cleanupPrivateInstance to run inside QCoreApplication's destructor.
+        // Register cleanupSettingsSaveThread to run inside QCoreApplication's destructor.
-        qAddPostRoutine(cleanupPrivateInstance);
+        // This will cleanup the settings thread and save all settings before shut down.
+        qAddPostRoutine(cleanupSettingsSaveThread);
     }
-    // Sets up the settings private instance. Should only be run once at startup. preInit() must be run beforehand,
+    // Sets up the settings private instance. Should only be run once at startup.
     void init() {
         // Set settings format
         QSettings::setDefaultFormat(JSON_FORMAT);
             qCDebug(shared) << (deleted ? "Deleted" : "Failed to delete") << "settings lock file" << settingsLockFilename;
         }
-        // Setup settings manager
+        // Setup settings manager, the manager will live until the process shuts down
         DependencyManager::set<Manager>();
         // Add pre-routine to setup threading
-        qAddPreRoutine(setupPrivateInstance);
+        qAddPreRoutine(setupSettingsSaveThread);
     }
     void Interface::init() {