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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_ReadableStream_h
#define mozilla_dom_ReadableStream_h
#include "js/TypeDecls.h"
#include "js/Value.h"
#include "mozilla/Attributes.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/IterableIterator.h"
#include "mozilla/dom/QueuingStrategyBinding.h"
#include "mozilla/dom/ReadableStreamController.h"
#include "mozilla/dom/ReadableStreamDefaultController.h"
#include "mozilla/dom/UnderlyingSourceCallbackHelpers.h"
#include "nsCycleCollectionParticipant.h"
#include "nsWrapperCache.h"
namespace mozilla::dom {
class Promise;
class ReadableStreamGenericReader;
class ReadableStreamDefaultReader;
class ReadableStreamGenericReader;
struct ReadableStreamGetReaderOptions;
struct ReadableStreamIteratorOptions;
struct ReadIntoRequest;
class WritableStream;
struct ReadableWritablePair;
struct StreamPipeOptions;
using ReadableStreamReader =
ReadableStreamDefaultReaderOrReadableStreamBYOBReader;
using OwningReadableStreamReader =
OwningReadableStreamDefaultReaderOrReadableStreamBYOBReader;
class NativeUnderlyingSource;
class BodyStreamHolder;
class UniqueMessagePortId;
class MessagePort;
class ReadableStream : public nsISupports, public nsWrapperCache {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(ReadableStream)
protected:
virtual ~ReadableStream();
nsCOMPtr<nsIGlobalObject> mGlobal;
public:
explicit ReadableStream(const GlobalObject& aGlobal);
explicit ReadableStream(nsIGlobalObject* aGlobal);
enum class ReaderState { Readable, Closed, Errored };
// Slot Getter/Setters:
public:
MOZ_KNOWN_LIVE ReadableStreamController* Controller() { return mController; }
ReadableStreamDefaultController* DefaultController() {
MOZ_ASSERT(mController && mController->IsDefault());
return mController->AsDefault();
}
void SetController(ReadableStreamController& aController) {
MOZ_ASSERT(!mController);
mController = &aController;
}
bool Disturbed() const { return mDisturbed; }
void SetDisturbed(bool aDisturbed) { mDisturbed = aDisturbed; }
ReadableStreamGenericReader* GetReader() { return mReader; }
void SetReader(ReadableStreamGenericReader* aReader);
ReadableStreamDefaultReader* GetDefaultReader();
ReaderState State() const { return mState; }
void SetState(const ReaderState& aState) { mState = aState; }
JS::Value StoredError() const { return mStoredError; }
void SetStoredError(JS::Handle<JS::Value> aStoredError) {
mStoredError = aStoredError;
}
BodyStreamHolder* GetBodyStreamHolder() {
if (UnderlyingSourceAlgorithmsBase* algorithms =
Controller()->GetAlgorithms()) {
return algorithms->GetBodyStreamHolder();
}
return nullptr;
}
// [Transferable]
// https://html.spec.whatwg.org/multipage/structured-data.html#transfer-steps
MOZ_CAN_RUN_SCRIPT bool Transfer(JSContext* aCx,
UniqueMessagePortId& aPortId);
// https://html.spec.whatwg.org/multipage/structured-data.html#transfer-receiving-steps
static MOZ_CAN_RUN_SCRIPT bool ReceiveTransfer(
JSContext* aCx, nsIGlobalObject* aGlobal, MessagePort& aPort,
JS::MutableHandle<JSObject*> aReturnObject);
// Public functions to implement other specs
// https://streams.spec.whatwg.org/#other-specs-rs-create
// The following algorithms must only be used on ReadableStream instances
// initialized via the above set up or set up with byte reading support
// algorithms (not, e.g., on web-developer-created instances):
MOZ_CAN_RUN_SCRIPT void CloseNative(JSContext* aCx, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT void EnqueueNative(JSContext* aCx,
JS::Handle<JS::Value> aChunk,
ErrorResult& aRv);
// IDL layer functions
nsIGlobalObject* GetParentObject() const { return mGlobal; }
JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
MOZ_CAN_RUN_SCRIPT static already_AddRefed<ReadableStream> Create(
JSContext* aCx, nsIGlobalObject* aGlobal,
BodyStreamHolder* aUnderlyingSource, ErrorResult& aRv);
// IDL Methods
// TODO: Use MOZ_CAN_RUN_SCRIPT when IDL constructors can use it (bug 1749042)
MOZ_CAN_RUN_SCRIPT_BOUNDARY static already_AddRefed<ReadableStream>
Constructor(const GlobalObject& aGlobal,
const Optional<JS::Handle<JSObject*>>& aUnderlyingSource,
const QueuingStrategy& aStrategy, ErrorResult& aRv);
bool Locked() const;
MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> Cancel(
JSContext* cx, JS::Handle<JS::Value> aReason, ErrorResult& aRv);
void GetReader(const ReadableStreamGetReaderOptions& aOptions,
OwningReadableStreamReader& resultReader, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT already_AddRefed<ReadableStream> PipeThrough(
const ReadableWritablePair& aTransform, const StreamPipeOptions& aOptions,
ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> PipeTo(
WritableStream& aDestinaton, const StreamPipeOptions& aOptions,
ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT void Tee(JSContext* aCx,
nsTArray<RefPtr<ReadableStream>>& aResult,
ErrorResult& aRv);
struct IteratorData {
void Traverse(nsCycleCollectionTraversalCallback& cb);
void Unlink();
RefPtr<ReadableStreamDefaultReader> mReader;
bool mPreventCancel;
};
using Iterator = AsyncIterableIterator<ReadableStream>;
void InitAsyncIteratorData(IteratorData& aData, Iterator::IteratorType aType,
const ReadableStreamIteratorOptions& aOptions,
ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> GetNextIterationResult(
Iterator* aIterator, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> IteratorReturn(
JSContext* aCx, Iterator* aIterator, JS::Handle<JS::Value> aValue,
ErrorResult& aRv);
// Internal Slots:
private:
RefPtr<ReadableStreamController> mController;
bool mDisturbed = false;
RefPtr<ReadableStreamGenericReader> mReader;
ReaderState mState = ReaderState::Readable;
JS::Heap<JS::Value> mStoredError;
};
bool IsReadableStreamLocked(ReadableStream* aStream);
double ReadableStreamGetNumReadRequests(ReadableStream* aStream);
void ReadableStreamError(JSContext* aCx, ReadableStream* aStream,
JS::Handle<JS::Value> aValue, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT void ReadableStreamClose(JSContext* aCx,
ReadableStream* aStream,
ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT void ReadableStreamFulfillReadRequest(
JSContext* aCx, ReadableStream* aStream, JS::Handle<JS::Value> aChunk,
bool done, ErrorResult& aRv);
void ReadableStreamAddReadRequest(ReadableStream* aStream,
ReadRequest* aReadRequest);
void ReadableStreamAddReadIntoRequest(ReadableStream* aStream,
ReadIntoRequest* aReadIntoRequest);
MOZ_CAN_RUN_SCRIPT already_AddRefed<Promise> ReadableStreamCancel(
JSContext* aCx, ReadableStream* aStream, JS::Handle<JS::Value> aError,
ErrorResult& aRv);
already_AddRefed<ReadableStreamDefaultReader>
AcquireReadableStreamDefaultReader(ReadableStream* aStream, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT already_AddRefed<ReadableStream> CreateReadableStream(
JSContext* aCx, nsIGlobalObject* aGlobal,
UnderlyingSourceAlgorithmsBase* aAlgorithms,
mozilla::Maybe<double> aHighWaterMark, QueuingStrategySize* aSizeAlgorithm,
ErrorResult& aRv);
bool ReadableStreamHasBYOBReader(ReadableStream* aStream);
bool ReadableStreamHasDefaultReader(ReadableStream* aStream);
MOZ_CAN_RUN_SCRIPT already_AddRefed<ReadableStream> CreateReadableByteStream(
JSContext* aCx, nsIGlobalObject* aGlobal,
UnderlyingSourceAlgorithmsBase* aAlgorithms, ErrorResult& aRv);
} // namespace mozilla::dom
#endif // mozilla_dom_ReadableStream_h
|
