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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Copyright (c) 2013, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Ford Motor Company nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SRC_COMPONENTS_INCLUDE_UTILS_MESSAGE_QUEUE_H_
#define SRC_COMPONENTS_INCLUDE_UTILS_MESSAGE_QUEUE_H_
#include <queue>
#include "utils/conditional_variable.h"
#include "utils/lock.h"
#include "utils/logger.h"
#include "utils/prioritized_queue.h"
/**
* \class MessageQueue
* \brief Wrapper for multithreading queue.
*/
namespace utils {
template<typename T, class Q = std::queue<T> > class MessageQueue {
public:
typedef Q Queue;
/**
* \brief Default constructor
*/
MessageQueue();
/**
* \brief Destructor
*/
~MessageQueue();
/**
* \brief Returns size of the queue.
* \return Size of the queue.
*/
size_t size() const;
/**
* \brief If queue is empty.
* \return Is queue empty.
*/
bool empty() const;
/**
* \brief Tells if queue is being shut down
*/
bool IsShuttingDown() const;
/**
* \brief Adds element to the queue.
* \param element Element to be added to the queue.n
*/
void push(const T& element);
/**
* \brief Removes element from the queue and returns it.
* \return To element of the queue.
*/
T pop();
/**
* \brief Conditional wait.
*/
void wait();
/**
* \brief Shutdown the queue.
* This leads to waking up everyone waiting on the queue
* Queue being shut down can be drained ( with pop() )
* But nothing must be added to the queue after it began
* shutting down
*/
void Shutdown();
/**
* \brief Clears queue.
*/
void Reset();
private:
/**
*\brief Queue
*/
Queue queue_;
volatile bool shutting_down_;
/**
*\brief Platform specific syncronisation variable
*/
mutable sync_primitives::Lock queue_lock_;
sync_primitives::ConditionalVariable queue_new_items_;
};
template<typename T, class Q> MessageQueue<T, Q>::MessageQueue()
: shutting_down_(false) {
}
template<typename T, class Q> MessageQueue<T, Q>::~MessageQueue() {
if (!queue_.empty()) {
CREATE_LOGGERPTR_LOCAL(logger_, "Utils")
LOG4CXX_ERROR(logger_, "Destruction of non-drained queue");
}
}
template<typename T, class Q> void MessageQueue<T, Q>::wait() {
sync_primitives::AutoLock auto_lock(queue_lock_);
while ((!shutting_down_) && queue_.empty()) {
queue_new_items_.Wait(auto_lock);
}
}
template<typename T, class Q> size_t MessageQueue<T, Q>::size() const {
sync_primitives::AutoLock auto_lock(queue_lock_);
return queue_.size();
}
template<typename T, class Q> bool MessageQueue<T, Q>::empty() const {
sync_primitives::AutoLock auto_lock(queue_lock_);
return queue_.empty();
}
template<typename T, class Q> bool MessageQueue<T, Q>::IsShuttingDown() const {
return shutting_down_;
}
template<typename T, class Q> void MessageQueue<T, Q>::push(const T& element) {
{
sync_primitives::AutoLock auto_lock(queue_lock_);
if (shutting_down_) {
CREATE_LOGGERPTR_LOCAL(logger_, "Utils")
LOG4CXX_ERROR(logger_, "Runtime error, pushing into queue"
" that is being shut down");
return;
}
queue_.push(element);
}
queue_new_items_.Broadcast();
}
template<typename T, class Q> T MessageQueue<T, Q>::pop() {
sync_primitives::AutoLock auto_lock(queue_lock_);
if (queue_.empty()) {
CREATE_LOGGERPTR_LOCAL(logger_, "Utils")
LOG4CXX_ERROR(logger_, "Runtime error, popping out of empty queue");
NOTREACHED();
}
T result = queue_.front();
queue_.pop();
return result;
}
template<typename T, class Q> void MessageQueue<T, Q>::Shutdown() {
sync_primitives::AutoLock auto_lock(queue_lock_);
shutting_down_ = true;
queue_new_items_.Broadcast();
}
template<typename T, class Q> void MessageQueue<T, Q>::Reset() {
sync_primitives::AutoLock auto_lock(queue_lock_);
shutting_down_ = false;
if (!queue_.empty()) {
Queue empty_queue;
queue_.swap(empty_queue);
}
}
} // namespace utils
#endif // SRC_COMPONENTS_INCLUDE_UTILS_MESSAGE_QUEUE_H_
|
