summaryrefslogtreecommitdiffstats
path: root/src/OSSupport/IsThread.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/OSSupport/IsThread.h')
-rw-r--r--src/OSSupport/IsThread.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/OSSupport/IsThread.h b/src/OSSupport/IsThread.h
index 4c2131d24..b53be5f4d 100644
--- a/src/OSSupport/IsThread.h
+++ b/src/OSSupport/IsThread.h
@@ -7,7 +7,8 @@
Usage:
To have a new thread, declare a class descending from cIsThread.
Then override its Execute() method to provide your thread processing.
-In the descending class' constructor call the Start() method to start the thread once you're finished with initialization.
+In the descending class' constructor call the Start() method to start the thread once you're finished with
+initialization.
*/
@@ -22,8 +23,7 @@ In the descending class' constructor call the Start() method to start the thread
class cIsThread
{
-public:
-
+ public:
cIsThread(AString && a_ThreadName);
virtual ~cIsThread();
@@ -36,16 +36,14 @@ public:
/** Returns true if the thread calling this function is the thread contained within this object. */
bool IsCurrentThread(void) const { return std::this_thread::get_id() == m_Thread.get_id(); }
-protected:
-
+ protected:
/** This function, overloaded by the descendants, is called in the new thread. */
virtual void Execute(void) = 0;
/** The overriden Execute() method should check this value periodically and terminate if this is true. */
std::atomic<bool> m_ShouldTerminate;
-private:
-
+ private:
/** The thread object which holds the created thread for later manipulation */
std::thread m_Thread;
@@ -53,13 +51,15 @@ private:
AString m_ThreadName;
/** The event that is used to wait with the thread's execution until the thread object is fully initialized.
- This prevents the IsCurrentThread() call to fail because of a race-condition where the thread starts before m_Thread has been fully assigned. */
+ This prevents the IsCurrentThread() call to fail because of a race-condition where the thread starts before m_Thread
+ has been fully assigned. */
cEvent m_Initialisation;
/** This is the main thread entrypoint.
- Wrapper for Execute() that waits for the initialization event, to prevent race conditions in thread initialization. */
+ Wrapper for Execute() that waits for the initialization event, to prevent race conditions in thread initialization.
+ */
void Entrypoint(void);
/** Sets the name of the current thread to be the name provided in m_ThreadName. */
void SetThreadName() const;
-} ;
+};