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
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
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef SYNC_QUEUE_H
#define SYNC_QUEUE_H
#include <mutex>
#include <queue>
/**
* Synchronized, locking queue. Safe for multiple producer/multiple consumer environments with
* nontrivial data (though bear in mind data needs to be copied in and out).
*/
template <typename T> class SYNC_QUEUE
{
typedef std::lock_guard<std::mutex> GUARD;
std::queue<T> m_queue;
mutable std::mutex m_mutex;
public:
SYNC_QUEUE()
{
}
/**
* Push a value onto the queue.
*/
void push( T const& aValue )
{
GUARD guard( m_mutex );
m_queue.push( aValue );
}
/**
* Move a value onto the queue. Useful for e.g. unique_ptr.
*/
void move_push( T&& aValue )
{
GUARD guard( m_mutex );
m_queue.push( std::move( aValue ) );
}
/**
* Pop a value off the queue into the provided variable. If the queue is empty, the
* variable is not touched.
*
* @return true iff a value was popped.
*/
bool pop( T& aReceiver )
{
GUARD guard( m_mutex );
if( m_queue.empty() )
{
return false;
}
else
{
aReceiver = std::move( m_queue.front() );
m_queue.pop();
return true;
}
}
/**
* Return true iff the queue is empty.
*/
bool empty() const
{
GUARD guard( m_mutex );
return m_queue.empty();
}
/**
* Return the size of the queue.
*/
size_t size() const
{
GUARD guard( m_mutex );
return m_queue.size();
}
/**
* Clear the queue.
*/
void clear()
{
GUARD guard( m_mutex );
while( !m_queue.empty() )
{
m_queue.pop();
}
}
};
#endif // SYNC_QUEUE_H
|
