1 /*
2 * Copyright (c) 2002-2025 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 * A JavaScript object for AbortController.
25 *
26 * @author Ronald Brill
27 */
28 @JsxClass
29 public class AbortController extends HtmlUnitScriptable {
30
31 private AbortSignal signal_;
32
33 /**
34 * JavaScript constructor.
35 */
36 @JsxConstructor
37 public void jsConstructor() {
38 signal_ = new AbortSignal();
39 signal_.setParentScope(this);
40 signal_.setPrototype(getPrototype(signal_.getClass()));
41 }
42
43 /**
44 * @return the {@link AbortSignal}
45 */
46 @JsxGetter
47 public AbortSignal getSignal() {
48 return signal_;
49 }
50
51 /**
52 * Aborts an asynchronous operation before it has completed. This is able to abort fetch requests,
53 * consumption of any response bodies, and streams.
54 */
55 @JsxFunction
56 public void abort() {
57 // empty impl for the moment
58 }
59 }