1/**************************************************************************/
2/* condition_variable.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef CONDITION_VARIABLE_H
32#define CONDITION_VARIABLE_H
33
34#include <condition_variable>
35
36// An object one or multiple threads can wait on a be notified by some other.
37// Normally, you want to use a semaphore for such scenarios, but when the
38// condition is something different than a count being greater than zero
39// (which is the built-in logic in a semaphore) or you want to provide your
40// own mutex to tie the wait-notify to some other behavior, you need to use this.
41
42class ConditionVariable {
43 mutable std::condition_variable condition;
44
45public:
46 template <class BinaryMutexT>
47 _ALWAYS_INLINE_ void wait(const MutexLock<BinaryMutexT> &p_lock) const {
48 condition.wait(const_cast<std::unique_lock<std::mutex> &>(p_lock.lock));
49 }
50
51 _ALWAYS_INLINE_ void notify_one() const {
52 condition.notify_one();
53 }
54
55 _ALWAYS_INLINE_ void notify_all() const {
56 condition.notify_all();
57 }
58};
59
60#endif // CONDITION_VARIABLE_H
61