cc05913a9247ffd5ac175c8e1acf4a413b78edba
[WebKit-https.git] / Source / WebCore / dom / AbortSignal.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "ContextDestructionObserver.h"
29 #include "EventTarget.h"
30 #include <wtf/Function.h>
31 #include <wtf/Ref.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/WeakPtr.h>
34
35 namespace WebCore {
36
37 class ScriptExecutionContext;
38
39 class AbortSignal final : public RefCounted<AbortSignal>, public EventTargetWithInlineData, public CanMakeWeakPtr<AbortSignal>, private ContextDestructionObserver {
40     WTF_MAKE_ISO_ALLOCATED(AbortSignal);
41 public:
42     static Ref<AbortSignal> create(ScriptExecutionContext&);
43
44     void abort();
45
46     bool aborted() const { return m_aborted; }
47
48     using RefCounted::ref;
49     using RefCounted::deref;
50
51     using Algorithm = WTF::Function<void()>;
52     void addAlgorithm(Algorithm&& algorithm) { m_algorithms.append(WTFMove(algorithm)); }
53
54     void follow(AbortSignal&);
55
56 private:
57     explicit AbortSignal(ScriptExecutionContext&);
58
59     EventTargetInterface eventTargetInterface() const final { return AbortSignalEventTargetInterfaceType; }
60     ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
61     void refEventTarget() final { ref(); }
62     void derefEventTarget() final { deref(); }
63     
64     bool m_aborted { false };
65     Vector<Algorithm> m_algorithms;
66 };
67
68 }
69