summaryrefslogtreecommitdiffstats
path: root/js/src/builtin/streams/ReadableStreamDefaultControllerOperations.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /js/src/builtin/streams/ReadableStreamDefaultControllerOperations.h
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--js/src/builtin/streams/ReadableStreamDefaultControllerOperations.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/js/src/builtin/streams/ReadableStreamDefaultControllerOperations.h b/js/src/builtin/streams/ReadableStreamDefaultControllerOperations.h
new file mode 100644
index 0000000000..9d17a855ae
--- /dev/null
+++ b/js/src/builtin/streams/ReadableStreamDefaultControllerOperations.h
@@ -0,0 +1,73 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ * vim: set ts=8 sts=2 et sw=2 tw=80:
+ * 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/. */
+
+/* Readable stream default controller abstract operations. */
+
+#ifndef builtin_streams_ReadableStreamDefaultControllerOperations_h
+#define builtin_streams_ReadableStreamDefaultControllerOperations_h
+
+#include "mozilla/Attributes.h" // MOZ_MUST_USE
+
+#include "jstypes.h" // JS_PUBLIC_API
+#include "js/RootingAPI.h" // JS::Handle
+#include "js/Value.h" // JS::Value
+
+struct JS_PUBLIC_API JSContext;
+
+namespace js {
+
+class ReadableStream;
+class ReadableStreamController;
+class ReadableStreamDefaultController;
+
+extern MOZ_MUST_USE bool ReadableStreamDefaultControllerEnqueue(
+ JSContext* cx,
+ JS::Handle<ReadableStreamDefaultController*> unwrappedController,
+ JS::Handle<JS::Value> chunk);
+
+extern MOZ_MUST_USE bool ReadableStreamControllerError(
+ JSContext* cx, JS::Handle<ReadableStreamController*> unwrappedController,
+ JS::Handle<JS::Value> e);
+
+extern MOZ_MUST_USE bool ReadableStreamDefaultControllerClose(
+ JSContext* cx,
+ JS::Handle<ReadableStreamDefaultController*> unwrappedController);
+
+extern MOZ_MUST_USE double ReadableStreamControllerGetDesiredSizeUnchecked(
+ ReadableStreamController* controller);
+
+extern MOZ_MUST_USE bool ReadableStreamControllerCallPullIfNeeded(
+ JSContext* cx, JS::Handle<ReadableStreamController*> unwrappedController);
+
+extern void ReadableStreamControllerClearAlgorithms(
+ JS::Handle<ReadableStreamController*> controller);
+
+/**
+ * Characterizes the family of algorithms, (startAlgorithm, pullAlgorithm,
+ * cancelAlgorithm), associated with a readable stream.
+ *
+ * See the comment on SetUpReadableStreamDefaultController().
+ */
+enum class SourceAlgorithms {
+ Script,
+ Tee,
+};
+
+extern MOZ_MUST_USE bool SetUpReadableStreamDefaultController(
+ JSContext* cx, JS::Handle<ReadableStream*> stream,
+ SourceAlgorithms sourceAlgorithms, JS::Handle<JS::Value> underlyingSource,
+ JS::Handle<JS::Value> pullMethod, JS::Handle<JS::Value> cancelMethod,
+ double highWaterMark, JS::Handle<JS::Value> size);
+
+extern MOZ_MUST_USE bool
+SetUpReadableStreamDefaultControllerFromUnderlyingSource(
+ JSContext* cx, JS::Handle<ReadableStream*> stream,
+ JS::Handle<JS::Value> underlyingSource, double highWaterMark,
+ JS::Handle<JS::Value> sizeAlgorithm);
+
+} // namespace js
+
+#endif // builtin_streams_ReadableStreamDefaultControllerOperations_h