stoppable_thread_impl.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details. You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_THREAD_STOPPABLE_THREAD_IMPL_HPP_
#define FOEDUS_THREAD_STOPPABLE_THREAD_IMPL_HPP_
#include <atomic>
#include <chrono>
#include <iosfwd>
#include <string>
#include <thread>

#include "foedus/thread/condition_variable_impl.hpp"

namespace foedus {
namespace thread {
class StoppableThread final {
 public:
  StoppableThread() : sleep_interval_(0),
    started_(false), stop_requested_(false), stopped_(false) {}

  // non-copyable assignable. (maybe better to provide move, but no need so far)
  StoppableThread(const StoppableThread &other) = delete;
  StoppableThread& operator=(const StoppableThread &other) = delete;
  StoppableThread(StoppableThread &&other) = delete;
  StoppableThread& operator=(StoppableThread &&other) = delete;

  void initialize(const std::string &name,
    std::thread &&the_thread, const std::chrono::microseconds &sleep_interval);
  void initialize(const std::string &name_prefix, int32_t name_ordinal,
    std::thread &&the_thread, const std::chrono::microseconds &sleep_interval);

  void stop();

  void request_stop();

  void wait_for_stop();

  void wakeup();

  bool sleep();

  bool is_stop_requested() const { return stop_requested_; }
  bool is_stop_requested_weak() const {
    return stop_requested_.load(std::memory_order_relaxed);
  }

  bool is_stopped() const { return stopped_; }
  bool is_stopped_weak() const { return stopped_.load(std::memory_order_relaxed); }

  template <typename HANDLE_TYPE>
  HANDLE_TYPE native_handle() { return static_cast<HANDLE_TYPE>(thread_.native_handle()); }

  std::string             to_string() const;
  friend std::ostream&    operator<<(std::ostream& o, const StoppableThread& v);

 private:
  std::string                     name_;
  std::thread                     thread_;
  std::chrono::microseconds       sleep_interval_;
  ConditionVariable               condition_;
  std::atomic<bool>               started_;
  std::atomic<bool>               stop_requested_;
  std::atomic<bool>               stopped_;
};


}  // namespace thread
}  // namespace foedus
#endif  // FOEDUS_THREAD_STOPPABLE_THREAD_IMPL_HPP_