1 /*
2 * Copyright (c) 2002-2026 Gargoyle Software Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * https://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15 package org.htmlunit.javascript.host.abort;
16
17 import org.htmlunit.javascript.HtmlUnitScriptable;
18 import org.htmlunit.javascript.configuration.JsxClass;
19 import org.htmlunit.javascript.configuration.JsxConstructor;
20 import org.htmlunit.javascript.configuration.JsxFunction;
21 import org.htmlunit.javascript.configuration.JsxGetter;
22
23 /**
24 * The JavaScript object {@code AbortController}.
25 *
26 * @author Ronald Brill
27 *
28 * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController">MDN Documentation</a>
29 */
30 @JsxClass
31 public class AbortController extends HtmlUnitScriptable {
32
33 private AbortSignal signal_;
34
35 /**
36 * JavaScript constructor.
37 */
38 @JsxConstructor
39 public void jsConstructor() {
40 signal_ = new AbortSignal();
41 signal_.setParentScope(getParentScope());
42 signal_.setPrototype(getPrototype(signal_.getClass()));
43 }
44
45 /**
46 * Returns the {@link AbortSignal} associated with this controller.
47 * @return the {@link AbortSignal}
48 */
49 @JsxGetter
50 public AbortSignal getSignal() {
51 return signal_;
52 }
53
54 /**
55 * Aborts an asynchronous operation before it has completed. This is able to abort fetch requests,
56 * consumption of any response bodies, and streams.
57 */
58 @JsxFunction
59 public void abort() {
60 // empty impl for the moment
61 }
62 }