hphp/util/synchronizable.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16
  17 #ifndef incl_HPHP_SYNCHRONIZABLE_H_
  18 #define incl_HPHP_SYNCHRONIZABLE_H_
  19
  20 #include "hphp/util/mutex.h"
  21 #include <pthread.h>
  22
  23 namespace HPHP {
  24 ///////////////////////////////////////////////////////////////////////////////
  25
  26 /**
  27  * Java-like base class for synchronization between object methods within the
  28  * same class. Check pool.h for a typical example.
  29  */
  30 struct Synchronizable {
  31   Synchronizable();
  32   virtual ~Synchronizable();
  33   Synchronizable(const Synchronizable&) = delete;
  34   Synchronizable& operator=(const Synchronizable&) = delete;
  35
  36   void wait();
  37   bool wait(long seconds); // false if timed out
  38   bool wait(long seconds, long long nanosecs); // false if timed out
  39   void notify();
  40   void notifyAll();
  41
  42   const Mutex& getMutex() const { return m_mutex; }
  43   Mutex& getMutex() { return m_mutex; }
  44
  45  private:
  46   Mutex m_mutex;
  47   pthread_cond_t m_cond;
  48 };
  49
  50 ///////////////////////////////////////////////////////////////////////////////
  51 }
  52
  53 #endif // incl_HPHP_SYNCHRONIZABLE_H_