thread.h 1.89 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
/*
 * Copyright 2009-2018 The VOTCA Development Team (http://www.votca.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef VOTCA_TOOLS_THREAD_H
#define VOTCA_TOOLS_THREAD_H

#include <pthread.h>

namespace votca {
namespace tools {

/**
 * \brief Framework for threaded execution
 *
 * The Thread class handles the threaded execution of VOTCA code.
 * In its current state, it is based on POSIX threads.
 * It mainly contains a wrapper, a start and a wait function.
 * This class should not be touched by the user.
 **/
class Thread {
 public:
  Thread();
  virtual ~Thread();

  /**
   * \brief Starts and runs a thread
   *
   * This method is responsible for creating and running the thread.
   **/
  void Start();

  /**
   * \brief WaitDone() will not exit until thread ends computation.
   */
  void WaitDone();

  /**
   * \brief Checks to see if the thread is done
   *
   * \return True if thread is done, False otherwise
   **/
  bool IsFinished() const;

 protected:
  /**
   * \brief Run() executes the actual code.
   *
   * It is left blank here and must be overloaded, for the thread to do
   * any work. This method should never be called by the user, it is
   * called internally by the Start method.
   */
  virtual void Run(void) = 0;
  friend void *runwrapper(void *arg);

 private:
  pthread_attr_t _attr;
  pthread_t _thread;
  bool _finished;
};
}
}

#endif  // VOTCA_TOOLS_THREAD_H