switched to autobrief
This commit is contained in:
+12
-12
@@ -25,61 +25,61 @@
|
||||
/** \file thread.h */
|
||||
|
||||
/**
|
||||
* @brief wrapper class for pthread.
|
||||
* wrapper class for pthread.
|
||||
*/
|
||||
class Thread
|
||||
{
|
||||
|
||||
public:
|
||||
/**
|
||||
* @brief constructor.
|
||||
* constructor.
|
||||
*/
|
||||
Thread() : m_threadid(0), m_started(false), m_running(false), m_stopped(false), m_detached(false) {}
|
||||
|
||||
/**
|
||||
* @brief virtual destructor.
|
||||
* virtual destructor.
|
||||
*/
|
||||
virtual ~Thread();
|
||||
|
||||
/**
|
||||
* @brief Thread entry helper for pthread_create.
|
||||
* Thread entry helper for pthread_create.
|
||||
* @param arg pointer to the @a Thread.
|
||||
* @return NULL.
|
||||
*/
|
||||
static void* runThread(void* arg);
|
||||
|
||||
/**
|
||||
* @brief Return whether this @a Thread is still running and not yet stopped.
|
||||
* Return whether this @a Thread is still running and not yet stopped.
|
||||
* @return true if this @a Thread is till running and not yet stopped.
|
||||
*/
|
||||
virtual bool isRunning() { return m_running == true && m_stopped == false; }
|
||||
|
||||
/**
|
||||
* @brief Create the native thread and set its name.
|
||||
* Create the native thread and set its name.
|
||||
* @param name the thread name to show in the process list.
|
||||
* @return whether the thread was started.
|
||||
*/
|
||||
virtual bool start(const char* name);
|
||||
|
||||
/**
|
||||
* @brief Notify the thread that it shall stop.
|
||||
* Notify the thread that it shall stop.
|
||||
*/
|
||||
virtual void stop() { m_stopped = true; }
|
||||
|
||||
/**
|
||||
* @brief Join the thread.
|
||||
* Join the thread.
|
||||
* @return whether the thread was joined.
|
||||
*/
|
||||
virtual bool join();
|
||||
|
||||
/**
|
||||
* @brief Detach the thread.
|
||||
* Detach the thread.
|
||||
* @return whether the thread was detached.
|
||||
*/
|
||||
virtual bool detach();
|
||||
|
||||
/**
|
||||
* @brief Get the thread id.
|
||||
* Get the thread id.
|
||||
* @return the thread id.
|
||||
*/
|
||||
pthread_t self() {return m_threadid; }
|
||||
@@ -87,14 +87,14 @@ public:
|
||||
protected:
|
||||
|
||||
/**
|
||||
* @brief Thread entry method to be overridden by derived class.
|
||||
* Thread entry method to be overridden by derived class.
|
||||
*/
|
||||
virtual void run() = 0;
|
||||
|
||||
private:
|
||||
|
||||
/**
|
||||
* @brief Enter the Thread loop by calling run().
|
||||
* Enter the Thread loop by calling run().
|
||||
*/
|
||||
void enter();
|
||||
|
||||
|
||||
Reference in New Issue
Block a user