Thread.h

Go to the documentation of this file.

#pragma once
 
#include <tdme/os/threading/fwd-tdme.h>
 
#include <tdme/tdme.h>
 
#if defined(CPPTHREADS)
    #include <thread>
    using std::thread;
#else
    #include <pthread.h>
#endif
 
#if !defined(_MSC_VER)
    #include <time.h>
#endif
 
#include <string>
 
using std::string;
 
/**
 * Base class for threads.
 * @author Andreas Drewke
 */
class tdme::os::threading::Thread {
public:
    /**
     * @brief Public constructor
     * @param name name
     * @param stackSize stack size, defaults to 2MB
     */
    Thread(const string& name, size_t stackSize = 2 * 1024 * 1024);
 
    /**
     * @brief Public destructor
     */
    virtual ~Thread();
 
    /**
     * @return hardware thread count
     */
    static int getHardwareThreadCount();
 
    /**
     * @brief sleeps current thread for given time in milliseconds
     * @param milliseconds uint64_t milliseconds to wait
     */
    static void sleep(const uint64_t milliseconds);
 
    /**
     * @brief Blocks caller thread until this thread has been terminated
     */
    void join();
 
    /**
     * @brief Starts this objects thread
     */
    void start();
 
    /**
     * @brief Abstract run() method, should be implemented by subclassed class, will be called after spawn by start()
     */
    virtual void run() = 0;
 
    /**
     * @brief Requests that this thread should be stopped
     */
    void stop();
 
    /**
     * @brief Returns if stop has been requested
     * @return bool
     */
    bool isStopRequested();
private:
    static void *pThreadRun(void *thread);
    #if defined(CPPTHREADS)
        thread* thread;
    #else
        pthread_t pThread;
    #endif
    string name;
    bool pThreadCreated;
    volatile bool stopRequested;
    size_t stackSize;
};