Class Thread

include/dmlc/thread_group.h:101–305

   * \note See gtest unit tests Syc.* for a usage examples
   */
  class Thread {
   public:
    /*! \brief Shared pointer type for readability */
    using SharedPtr = std::shared_ptr<Thread>;

    /*!
     * \brief Constructor
     * \param threadName User-defined name of the thread. must be unique per ThreadGroup
     * \param owner The ThreadGroup object managing the lifecycle of this thread
     * \param thrd Optionally-assigned std::thread object associated with this Thread class
     */
    Thread(std::string threadName, ThreadGroup *owner, std::thread *thrd = nullptr)
      : name_(std::move(threadName))
        , thread_(thrd)
        , ready_event_(std::make_shared<ManualEvent>())
        , start_event_(std::make_shared<ManualEvent>())
        , owner_(owner)
        , shutdown_requested_(false)
        , auto_remove_(false) {
      CHECK_NOTNULL(owner);
    }

    /*!
     * \brief Destructor with cleanup
     */
    virtual ~Thread() {
      const bool self_delete = is_current_thread();
      if (!self_delete) {
        request_shutdown();
        internal_join(true);
      }
      WriteLock guard(thread_mutex_);
      if (thread_.load()) {
        std::thread *thrd = thread_.load();
        thread_ = nullptr;
        if (self_delete) {
          thrd->detach();
        }
        delete thrd;
      }
    }

    /*!
     * \brief Name of the thread
     * \return Pointer to the thread name's string
     * \note This shoul ndly be used as immediate for the sacope of the
     *       shared pointer pointing to this object
     */
    const char *name() const {
      return name_.c_str();
    }

    /*!
     * \brief Launch the given Thread object
     * \tparam StartFunction Function type for the thread 'main' function
     * \tparam Args Arguments to pass to the thread 'main' function
     * \param pThis Shared pointer for the managed thread to launch
     * \param autoRemove if true, automatically remove this Thread object from the