tmp
[blender.git] / extern / audaspace / include / util / Barrier.h
1 /*******************************************************************************
2 * Copyright 2015-2016 Juan Francisco Crespo Gal├ín
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *   http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 ******************************************************************************/
16
17 #pragma once
18
19 /**
20 * @file Barrier.h
21 * @ingroup util
22 * The Barrier class.
23 */
24
25 #include "Audaspace.h"
26
27 #include <mutex>
28 #include <condition_variable>
29
30 AUD_NAMESPACE_BEGIN
31 /**
32 * This represents a barrier mechanism for thread sychronization.
33 */
34 class Barrier 
35 {
36 private:
37         /**
38         * A mutex needed to use a condition variable.
39         */
40         std::mutex m_mutex;
41
42         /**
43         * Condition varieble used to sync threads.
44         */
45         std::condition_variable m_condition;
46         
47         /**
48         * Number of threads that need to reach the barrier for it to lift.
49         */
50         unsigned int m_threshold;
51
52         /**
53         * Conter that count from threshold to 0.
54         */
55         unsigned int m_count;
56
57         /**
58         * Variable used for predicate check in the condition variable wait.
59         */
60         unsigned int m_generation;
61
62         // delete copy constructor and operator=
63         Barrier(const Barrier&) = delete;
64         Barrier& operator=(const Barrier&) = delete;
65 public:
66         /**
67         * Creates a new Barrier object.
68         * \param count the number of threads that need to reach the barrier for it to lift.
69         */
70         Barrier(unsigned int count);
71         virtual ~Barrier();
72
73         /**
74         * Makes the caller thread wait until enough threads are stopped by this method.
75         */
76         void wait();
77 };
78 AUD_NAMESPACE_END