blob: d9e8bf07f827a236c7b879359d5f6dcd44b2ea2a (
plain)
1
2
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
|
/*******************************************************************************
* Copyright 2015-2016 Juan Francisco Crespo Galán
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
#pragma once
/**
* @file Barrier.h
* @ingroup util
* The Barrier class.
*/
#include "Audaspace.h"
#include <mutex>
#include <condition_variable>
AUD_NAMESPACE_BEGIN
/**
* This represents a barrier mechanism for thread sychronization.
*/
class Barrier
{
private:
/**
* A mutex needed to use a condition variable.
*/
std::mutex m_mutex;
/**
* Condition varieble used to sync threads.
*/
std::condition_variable m_condition;
/**
* Number of threads that need to reach the barrier for it to lift.
*/
unsigned int m_threshold;
/**
* Conter that count from threshold to 0.
*/
unsigned int m_count;
/**
* Variable used for predicate check in the condition variable wait.
*/
unsigned int m_generation;
// delete copy constructor and operator=
Barrier(const Barrier&) = delete;
Barrier& operator=(const Barrier&) = delete;
public:
/**
* Creates a new Barrier object.
* \param count the number of threads that need to reach the barrier for it to lift.
*/
Barrier(unsigned int count);
virtual ~Barrier();
/**
* Makes the caller thread wait until enough threads are stopped by this method.
*/
void wait();
};
AUD_NAMESPACE_END
|