Embedded Multicore Building Blocks V1.0.0
condition_variable.h
1 /*
2  * Copyright (c) 2014-2017, Siemens AG. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef EMBB_BASE_CONDITION_VARIABLE_H_
28 #define EMBB_BASE_CONDITION_VARIABLE_H_
29 
30 #include <embb/base/internal/platform.h>
31 #include <embb/base/mutex.h>
32 #include <embb/base/time.h>
33 
34 namespace embb {
35 namespace base {
36 
57  public:
68 
78  void NotifyOne();
79 
89  void NotifyAll();
90 
107  void Wait(
108  UniqueLock<Mutex>& lock
110  );
111 
130  bool WaitUntil(
131  UniqueLock<Mutex>& lock,
133  const Time& time
135  );
136 
157  template<typename Tick>
158  bool WaitFor(
159  UniqueLock<Mutex>& lock,
161  const Duration<Tick>& duration
163  );
164 
165  private:
170  ConditionVariable& operator=(const ConditionVariable&);
171 
175  internal::ConditionVariableType condition_var_;
176 };
177 
178 } // namespace base
179 } // namespace embb
180 
181 #include <embb/base/internal/condition_variable-inl.h>
182 
183 #endif // EMBB_BASE_CONDITION_VARIABLE_H_
Definition: lock_free_mpmc_queue.h:40
bool WaitFor(UniqueLock< Mutex > &lock, const Duration< Tick > &duration)
Releases the lock and waits until the thread is woken up or the specified duration has passed...
bool WaitUntil(UniqueLock< Mutex > &lock, const Time &time)
Releases the lock and waits until the thread is woken up or the specified time point has passed...
void Wait(UniqueLock< Mutex > &lock)
Releases the lock and waits until the thread is woken up.
void NotifyOne()
Wakes up one waiting thread.
void NotifyAll()
Wakes up all waiting threads.
Represents a relative time duration for a given tick type.
Definition: duration.h:57
Represents a condition variable for thread synchronization.
Definition: condition_variable.h:56
ConditionVariable()
Creates a condition variable.
Represents an absolute time point.
Definition: time.h:41
Flexible ownership wrapper for a mutex.
Definition: mutex.h:491