[WTF] Import std::optional reference implementation as WTF::Optional
[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 #include <wtf/Threading.h>
36
37 namespace WTF {
38
39 template<typename DataType>
40 class CrossThreadQueue {
41     WTF_MAKE_NONCOPYABLE(CrossThreadQueue);
42 public:
43     CrossThreadQueue() = default;
44
45     void append(DataType&&);
46
47     DataType waitForMessage();
48     std::optional<DataType> tryGetMessage();
49
50     bool isKilled() const { return false; }
51
52 private:
53     mutable Lock m_lock;
54     Condition m_condition;
55     Deque<DataType> m_queue;
56 };
57
58 template<typename DataType>
59 void CrossThreadQueue<DataType>::append(DataType&& message)
60 {
61     LockHolder lock(m_lock);
62     m_queue.append(WTFMove(message));
63     m_condition.notifyOne();
64 }
65
66 template<typename DataType>
67 DataType CrossThreadQueue<DataType>::waitForMessage()
68 {
69     LockHolder lock(m_lock);
70
71     auto found = m_queue.end();
72     while (found == m_queue.end()) {
73         found = m_queue.begin();
74         if (found != m_queue.end())
75             break;
76
77         m_condition.wait(m_lock);
78     }
79
80     return m_queue.takeFirst();
81 }
82
83 template<typename DataType>
84 std::optional<DataType> CrossThreadQueue<DataType>::tryGetMessage()
85 {
86     LockHolder lock(m_lock);
87
88     if (m_queue.isEmpty())
89         return { };
90
91     return m_queue.takeFirst();
92 }
93
94 } // namespace WTF
95
96 using WTF::CrossThreadQueue;