[Streams API] Collecting a ReadableStreamReader should not unlock its stream
[WebKit-https.git] / Source / WebCore / Modules / streams / ReadableStream.h
1 /*
2  * Copyright (C) 2015 Canon Inc.
3  * Copyright (C) 2015 Igalia S.L.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted, provided that the following conditions
7  * are required to be met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Canon Inc. nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef ReadableStream_h
31 #define ReadableStream_h
32
33 #if ENABLE(STREAMS_API)
34
35 #include "ActiveDOMObject.h"
36 #include "ReadableStreamSource.h"
37 #include "ScriptWrappable.h"
38 #include <functional>
39 #include <wtf/Ref.h>
40
41 namespace WebCore {
42
43 class ReadableStreamReader;
44 class ScriptExecutionContext;
45
46 // ReadableStream implements the core of the streams API ReadableStream functionality.
47 // It handles in particular the backpressure according the queue size.
48 // ReadableStream is using a ReadableStreamSource to get data in its queue.
49 // See https://streams.spec.whatwg.org/#rs
50 class ReadableStream : public ActiveDOMObject, public ScriptWrappable, public RefCounted<ReadableStream> {
51 public:
52     enum class State {
53         Readable,
54         Closed,
55         Errored
56     };
57
58     virtual ~ReadableStream();
59
60     ReadableStreamReader* reader() { return m_reader; }
61     virtual Ref<ReadableStreamReader> createReader() = 0;
62
63     bool isLocked() const { return m_isLocked; }
64     void lock(ReadableStreamReader&);
65     void release();
66     void releaseButKeepLocked();
67
68     State internalState() { return m_state; }
69
70 protected:
71     ReadableStream(ScriptExecutionContext&, Ref<ReadableStreamSource>&&);
72
73 private:
74     // ActiveDOMObject API.
75     const char* activeDOMObjectName() const override;
76     bool canSuspend() const override;
77
78     State m_state;
79     Ref<ReadableStreamSource> m_source;
80     ReadableStreamReader* m_reader { nullptr };
81     bool m_isLocked { false };
82 };
83
84 inline void ReadableStream::lock(ReadableStreamReader& reader)
85 {
86     m_reader = &reader;
87     m_isLocked = true;
88 }
89
90 inline void ReadableStream::release()
91 {
92     m_reader = nullptr;
93     m_isLocked = false;
94 }
95
96 inline void ReadableStream::releaseButKeepLocked()
97 {
98     m_reader = nullptr;
99     m_isLocked = true;
100 }
101
102
103
104 }
105
106 #endif
107
108 #endif // ReadableStream_h