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
|
/*
* Copyright (C) 2022-2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 APPLE INC. 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.
*/
#pragma once
#include "ContextDestructionObserver.h"
#include "InternalReadableStream.h"
#include "JSValueInWrappedObject.h"
#include "ReadableByteStreamController.h"
#include <JavaScriptCore/Strong.h>
#include <wtf/RefCountedAndCanMakeWeakPtr.h>
#include <wtf/WeakPtr.h>
namespace JSC {
class AbstractSlotVisitor;
}
namespace WebCore {
class DOMPromise;
class DeferredPromise;
class InternalReadableStream;
class JSDOMGlobalObject;
class ReadableStreamBYOBReader;
class ReadableStreamDefaultReader;
class ReadableStreamReadRequest;
class ReadableStreamSource;
class WritableStream;
struct StreamPipeOptions;
struct UnderlyingSource;
using ReadableStreamReader = Variant<RefPtr<ReadableStreamDefaultReader>, RefPtr<ReadableStreamBYOBReader>>;
class ReadableStream : public RefCountedAndCanMakeWeakPtr<ReadableStream>, public ContextDestructionObserver {
public:
enum class ReaderMode { Byob };
struct GetReaderOptions {
std::optional<ReaderMode> mode;
};
struct WritablePair {
RefPtr<ReadableStream> readable;
RefPtr<WritableStream> writable;
};
static ExceptionOr<Ref<ReadableStream>> create(JSDOMGlobalObject&, std::optional<JSC::Strong<JSC::JSObject>>&&, std::optional<JSC::Strong<JSC::JSObject>>&&);
static ExceptionOr<Ref<ReadableStream>> create(JSDOMGlobalObject&, Ref<ReadableStreamSource>&&);
static ExceptionOr<Ref<ReadableStream>> createFromByteUnderlyingSource(JSDOMGlobalObject&, JSC::JSValue underlyingSource, UnderlyingSource&&, double highWaterMark);
static Ref<ReadableStream> create(Ref<InternalReadableStream>&&);
virtual ~ReadableStream();
Ref<DOMPromise> cancelForBindings(JSDOMGlobalObject&, JSC::JSValue);
ExceptionOr<ReadableStreamReader> getReader(JSDOMGlobalObject&, const GetReaderOptions&);
ExceptionOr<Vector<Ref<ReadableStream>>> tee(JSDOMGlobalObject&, bool shouldClone = false);
using State = InternalReadableStream::State;
State state() const;
void lock();
bool isLocked() const;
WEBCORE_EXPORT bool isDisturbed() const;
Ref<DOMPromise> cancel(JSDOMGlobalObject&, JSC::JSValue);
void cancel(Exception&&);
InternalReadableStream* internalReadableStream() { return m_internalReadableStream.get(); }
void setDefaultReader(ReadableStreamDefaultReader*);
ReadableStreamDefaultReader* defaultReader();
void pipeTo(ReadableStreamSink&);
bool hasByteStreamController() { return !!m_controller; }
ReadableByteStreamController* controller() { return m_controller.get(); }
RefPtr<ReadableByteStreamController> protectedController() { return m_controller.get(); }
void setByobReader(ReadableStreamBYOBReader*);
ReadableStreamBYOBReader* byobReader();
void fulfillReadIntoRequest(JSDOMGlobalObject&, RefPtr<JSC::ArrayBufferView>&&, bool done);
void fulfillReadRequest(JSDOMGlobalObject&, RefPtr<JSC::ArrayBufferView>&&, bool done);
void markAsDisturbed() { m_disturbed = true; }
void close();
JSC::JSValue storedError(JSDOMGlobalObject&) const;
size_t getNumReadRequests() const;
void addReadRequest(Ref<ReadableStreamReadRequest>&&);
size_t getNumReadIntoRequests() const;
void addReadIntoRequest(Ref<ReadableStreamReadIntoRequest>&&);
void error(JSDOMGlobalObject&, JSC::JSValue);
void pipeTo(JSDOMGlobalObject&, WritableStream&, StreamPipeOptions&&, Ref<DeferredPromise>&&);
ExceptionOr<Ref<ReadableStream>> pipeThrough(JSDOMGlobalObject&, WritablePair&&, StreamPipeOptions&&);
void visitAdditionalChildren(JSC::AbstractSlotVisitor&);
static Ref<ReadableStream> createReadableByteStream(JSDOMGlobalObject&, ReadableByteStreamController::PullAlgorithm&&, ReadableByteStreamController::CancelAlgorithm&&, RefPtr<ReadableStream>&& = { });
enum class Type : bool {
Default,
WebTransport
};
virtual Type type() const { return Type::Default; }
protected:
static ExceptionOr<Ref<ReadableStream>> createFromJSValues(JSC::JSGlobalObject&, JSC::JSValue, JSC::JSValue);
static ExceptionOr<Ref<InternalReadableStream>> createInternalReadableStream(JSDOMGlobalObject&, Ref<ReadableStreamSource>&&);
explicit ReadableStream(ScriptExecutionContext*, RefPtr<InternalReadableStream>&& = { }, RefPtr<ReadableStream>&& = { });
private:
ExceptionOr<void> setupReadableByteStreamControllerFromUnderlyingSource(JSDOMGlobalObject&, JSC::JSValue, UnderlyingSource&&, double);
void setupReadableByteStreamController(JSDOMGlobalObject&, ReadableByteStreamController::PullAlgorithm&&, ReadableByteStreamController::CancelAlgorithm&&, double);
bool m_disturbed { false };
WeakPtr<ReadableStreamDefaultReader> m_defaultReader;
WeakPtr<ReadableStreamBYOBReader> m_byobReader;
State m_state { State::Readable };
const std::unique_ptr<ReadableByteStreamController> m_controller;
const RefPtr<InternalReadableStream> m_internalReadableStream;
const RefPtr<ReadableStream> m_relatedStreamForGC;
};
} // namespace WebCore
|
