condition_variable.h 4.91 KB
Newer Older
1
/*
Marcus Winter committed
2
 * Copyright (c) 2014-2016, Siemens AG. All rights reserved.
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 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMBB_BASE_CONDITION_VARIABLE_H_
#define EMBB_BASE_CONDITION_VARIABLE_H_

#include <embb/base/internal/platform.h>
#include <embb/base/mutex.h>
#include <embb/base/time.h>

namespace embb {
namespace base {

/**
 * \defgroup CPP_BASE_CONDITION Condition Variable
 *
 * Condition variables for thread synchronization.
 *
 * \ingroup CPP_BASE
 */

/**
 * Represents a condition variable for thread synchronization.
 *
 * Provides an abstraction from platform-specific condition variable
 * implementations. Condition variables can be waited for with timeouts using
 * relative durations and absolute time points.
 *
 * This class is essentially a wrapper for the underlying C implementation.
 *
 * \ingroup CPP_BASE_CONDITION
 */
class ConditionVariable {
 public:
  /**
   * Creates a condition variable.
   *
   * \throws embb::base::ErrorException if initialization failed
   *
   * \memory Potentially allocates dynamic memory
   *
   * \notthreadsafe
   */
  ConditionVariable();

  /**
   * Wakes up one waiting thread.
   *
   * \throws embb::base::ErrorException if notification failed
   *
   * \threadsafe
   *
   * \see NotifyAll(), Wait()
   */
  void NotifyOne();

  /**
   * Wakes up all waiting threads.
   *
   * \throws embb::base::ErrorException if notification failed
   *
   * \threadsafe
   *
   * \see NotifyOne(), Wait()
   */
  void NotifyAll();

  /**
   * Releases the lock and waits until the thread is woken up.
   *
   * \pre The lock has been acquired by the calling thread.
   * \post The lock has been re-acquired by the calling thread.
   *
   * \throws embb::base::ErrorException if waiting failed
   *
   * \threadsafe
   *
   * \see NotifyOne(), NotifyAll()
   */
  void Wait(
    UniqueLock<Mutex>& lock
    /**< [IN,OUT] Lock to be released and re-acquired */
    );

  /**
   * Releases the lock and waits until the thread is woken up or the specified
   * time point has passed.
   *
   * \pre The lock has been acquired by the calling thread.
   * \post The lock has been re-acquired by the calling thread.
   *
   * \return \c true if the thread was woken up before the specified time point
   *         has passed, otherwise \c false.
   *
   * \throws embb::base::ErrorException if an error occurred
   *
   * \threadsafe
   */
  bool WaitUntil(
    UniqueLock<Mutex>& lock,
    /**< [IN,OUT] Lock to be released and re-acquired */
    const Time& time
    /**< [IN] Absolute time point until which the thread maximally waits */
    );

  /**
   * Releases the lock and waits until the thread is woken up or the specified
   * duration has passed.
   *
   * \pre The lock has been acquired by the calling thread.
   * \post The lock has been re-acquired by the calling thread.
   *
   * \return \c true if the thread was woken up before the specified duration
   *         has passed, otherwise \c false.
   *
   * \throws embb::base::ErrorException if an error occurred
   *
   * \threadsafe
   *
   * \tparam Tick Type of tick of the duration. See Duration.
   */
  template<typename Tick>
  bool WaitFor(
    UniqueLock<Mutex>& lock,
    /**< [IN,OUT] Lock to be released and re-acquired */
    const Duration<Tick>& duration
    /**< [IN] Relative time duration the thread maximally waits */
    );

 private:
  /**
   * Disables copying and assigment.
   */
  ConditionVariable(const ConditionVariable&);
  ConditionVariable& operator=(const ConditionVariable&);

  /**
   * Holds actual condition variable.
   */
  internal::ConditionVariableType condition_var_;
};

} // namespace base
} // namespace embb

#include <embb/base/internal/condition_variable-inl.h>

#endif // EMBB_BASE_CONDITION_VARIABLE_H_