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
|
/*
* Copyright (C) 2019 The Android Open Source Project
*
* 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.
*/
#ifndef _UI_INPUT_BLOCKING_QUEUE_H
#define _UI_INPUT_BLOCKING_QUEUE_H
#include <condition_variable>
#include <functional>
#include <mutex>
#include <vector>
#include "android-base/thread_annotations.h"
namespace android {
/**
* A FIFO queue that stores up to <i>capacity</i> objects.
* Objects can always be added. Objects are added immediately.
* If the queue is full, new objects cannot be added.
*
* The action of retrieving an object will block until an element is available.
*/
template <class T>
class BlockingQueue {
public:
BlockingQueue(size_t capacity) : mCapacity(capacity) {
mQueue.reserve(mCapacity);
};
/**
* Retrieve and remove the oldest object.
* Blocks execution while queue is empty.
*/
T pop() {
std::unique_lock lock(mLock);
android::base::ScopedLockAssertion assumeLock(mLock);
mHasElements.wait(lock, [this]() REQUIRES(mLock) { return !this->mQueue.empty(); });
T t = std::move(mQueue.front());
mQueue.erase(mQueue.begin());
return t;
};
/**
* Add a new object to the queue.
* Does not block.
* Return true if an element was successfully added.
* Return false if the queue is full.
*/
bool push(T&& t) {
{
std::scoped_lock lock(mLock);
if (mQueue.size() == mCapacity) {
return false;
}
mQueue.push_back(std::move(t));
}
mHasElements.notify_one();
return true;
};
void erase(const std::function<bool(const T&)>& lambda) {
std::scoped_lock lock(mLock);
std::erase_if(mQueue, [&lambda](const auto& t) { return lambda(t); });
}
/**
* Remove all elements.
* Does not block.
*/
void clear() {
std::scoped_lock lock(mLock);
mQueue.clear();
};
/**
* How many elements are currently stored in the queue.
* Primary used for debugging.
* Does not block.
*/
size_t size() {
std::scoped_lock lock(mLock);
return mQueue.size();
}
private:
const size_t mCapacity;
/**
* Used to signal that mQueue is non-empty.
*/
std::condition_variable mHasElements;
/**
* Lock for accessing and waiting on elements.
*/
std::mutex mLock;
std::vector<T> mQueue GUARDED_BY(mLock);
};
} // namespace android
#endif
|
