Userland/Libraries/LibWeb/DOM/AbortController.h


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

/*
 * Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/RefCounted.h>
#include <AK/Weakable.h>
#include <LibWeb/Bindings/WindowObject.h>
#include <LibWeb/Bindings/Wrappable.h>
#include <LibWeb/DOM/AbortSignal.h>
#include <LibWeb/DOM/Window.h>
#include <LibWeb/Forward.h>

namespace Web::DOM {

// https://dom.spec.whatwg.org/#abortcontroller
class AbortController final
    : public RefCounted<AbortController>
    , public Weakable<AbortController>
    , public Bindings::Wrappable {
public:
    using WrapperType = Bindings::AbortControllerWrapper;

    static NonnullRefPtr<AbortController> create(Document& document)
    {
        return adopt_ref(*new AbortController(document));
    }

    static NonnullRefPtr<AbortController> create_with_global_object(Bindings::WindowObject& window_object)
    {
        return AbortController::create(window_object.impl().associated_document());
    }

    virtual ~AbortController() override;

    // https://dom.spec.whatwg.org/#dom-abortcontroller-signal
    NonnullRefPtr<AbortSignal> signal() const { return m_signal; }

    void abort(JS::Value reason);

private:
    AbortController(Document& document);

    // https://dom.spec.whatwg.org/#abortcontroller-signal
    NonnullRefPtr<AbortSignal> m_signal;
};

}