9681bec76a7a10e976d8c69169fbad53befc4beb
[WebKit-https.git] / Source / WTF / wtf / CrossThreadQueue.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <limits>
29 #include <wtf/Assertions.h>
30 #include <wtf/Condition.h>
31 #include <wtf/Deque.h>
32 #include <wtf/Lock.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/Optional.h>
35
36 namespace WTF {
37
38 template<typename DataType>
39 class CrossThreadQueue {
40     WTF_MAKE_NONCOPYABLE(CrossThreadQueue);
41 public:
42     CrossThreadQueue() = default;
43
44     void append(DataType&&);
45
46     DataType waitForMessage();
47     std::optional<DataType> tryGetMessage();
48
49     bool isKilled() const { return false; }
50
51 private:
52     mutable Lock m_lock;
53     Condition m_condition;
54     Deque<DataType> m_queue;
55 };
56
57 template<typename DataType>
58 void CrossThreadQueue<DataType>::append(DataType&& message)
59 {
60     LockHolder lock(m_lock);
61     m_queue.append(WTFMove(message));
62     m_condition.notifyOne();
63 }
64
65 template<typename DataType>
66 DataType CrossThreadQueue<DataType>::waitForMessage()
67 {
68     LockHolder lock(m_lock);
69
70     auto found = m_queue.end();
71     while (found == m_queue.end()) {
72         found = m_queue.begin();
73         if (found != m_queue.end())
74             break;
75
76         m_condition.wait(m_lock);
77     }
78
79     return m_queue.takeFirst();
80 }
81
82 template<typename DataType>
83 std::optional<DataType> CrossThreadQueue<DataType>::tryGetMessage()
84 {
85     LockHolder lock(m_lock);
86
87     if (m_queue.isEmpty())
88         return { };
89
90     return m_queue.takeFirst();
91 }
92
93 } // namespace WTF
94
95 using WTF::CrossThreadQueue;