mirror of
https://github.com/RGBCube/serenity
synced 2025-07-25 11:17:43 +00:00
LibWeb: Add the WritableStreamDefaultController
This commit is contained in:
parent
83701ec54b
commit
868cd95069
10 changed files with 393 additions and 5 deletions
|
@ -0,0 +1,96 @@
|
|||
/*
|
||||
* Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-2-Clause
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <AK/SinglyLinkedList.h>
|
||||
#include <LibWeb/Bindings/PlatformObject.h>
|
||||
#include <LibWeb/Streams/AbstractOperations.h>
|
||||
|
||||
namespace Web::Streams {
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller
|
||||
class WritableStreamDefaultController final : public Bindings::PlatformObject {
|
||||
WEB_PLATFORM_OBJECT(WritableStreamDefaultController, Bindings::PlatformObject);
|
||||
|
||||
public:
|
||||
virtual ~WritableStreamDefaultController() override = default;
|
||||
|
||||
WebIDL::ExceptionOr<void> error(JS::Value error);
|
||||
JS::NonnullGCPtr<DOM::AbortSignal> signal() { return *m_signal; }
|
||||
|
||||
auto& abort_algorithm() { return m_abort_algorithm; }
|
||||
void set_abort_algorithm(Optional<AbortAlgorithm>&& value) { m_abort_algorithm = move(value); }
|
||||
|
||||
auto& close_algorithm() { return m_close_algorithm; }
|
||||
void set_close_algorithm(Optional<CloseAlgorithm>&& value) { m_close_algorithm = move(value); }
|
||||
|
||||
SinglyLinkedList<ValueWithSize>& queue() { return m_queue; }
|
||||
|
||||
double queue_total_size() const { return m_queue_total_size; }
|
||||
void set_queue_total_size(double value) { m_queue_total_size = value; }
|
||||
|
||||
bool started() const { return m_started; }
|
||||
void set_started(bool value) { m_started = value; }
|
||||
|
||||
size_t strategy_hwm() const { return m_strategy_hwm; }
|
||||
void set_strategy_hwm(size_t value) { m_strategy_hwm = value; }
|
||||
|
||||
auto& strategy_size_algorithm() { return m_strategy_size_algorithm; }
|
||||
void set_strategy_size_algorithm(Optional<SizeAlgorithm>&& value) { m_strategy_size_algorithm = move(value); }
|
||||
|
||||
JS::NonnullGCPtr<WritableStream> stream() { return *m_stream; }
|
||||
void set_stream(JS::NonnullGCPtr<WritableStream> value) { m_stream = value; }
|
||||
|
||||
auto& write_algorithm() { return m_write_algorithm; }
|
||||
void set_write_algorithm(Optional<WriteAlgorithm>&& value) { m_write_algorithm = move(value); }
|
||||
|
||||
WebIDL::ExceptionOr<JS::GCPtr<WebIDL::Promise>> abort_steps(JS::Value reason);
|
||||
void error_steps();
|
||||
|
||||
private:
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-abortalgorithm
|
||||
// A promise-returning algorithm, taking one argument (the abort reason), which communicates a requested abort to the underlying sink
|
||||
Optional<AbortAlgorithm> m_abort_algorithm;
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-closealgorithm
|
||||
// A promise-returning algorithm which communicates a requested close to the underlying sink
|
||||
Optional<CloseAlgorithm> m_close_algorithm;
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-queue
|
||||
// A list representing the stream’s internal queue of chunks
|
||||
SinglyLinkedList<ValueWithSize> m_queue;
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-queuetotalsize
|
||||
// The total size of all the chunks stored in [[queue]]
|
||||
double m_queue_total_size { 0 };
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-signal
|
||||
// An AbortSignal that can be used to abort the pending write or close operation when the stream is aborted.
|
||||
JS::GCPtr<DOM::AbortSignal> m_signal;
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-started
|
||||
// A boolean flag indicating whether the underlying sink has finished starting
|
||||
bool m_started { false };
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-strategyhwm
|
||||
// A number supplied by the creator of the stream as part of the stream’s queuing strategy, indicating the point at which the stream will apply backpressure to its underlying sink
|
||||
size_t m_strategy_hwm { 0 };
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-strategysizealgorithm
|
||||
// An algorithm to calculate the size of enqueued chunks, as part of the stream’s queuing strategy
|
||||
Optional<SizeAlgorithm> m_strategy_size_algorithm;
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-stream
|
||||
// The WritableStream instance controlled
|
||||
JS::GCPtr<WritableStream> m_stream;
|
||||
|
||||
// https://streams.spec.whatwg.org/#writablestreamdefaultcontroller-writealgorithm
|
||||
// A promise-returning algorithm, taking one argument (the chunk to write), which writes data to the underlying sink
|
||||
Optional<WriteAlgorithm> m_write_algorithm;
|
||||
};
|
||||
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue