File: WorkerTestUtils.h

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (58 lines) | stat: -rw-r--r-- 2,002 bytes parent folder | download | duplicates (4)
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
52
53
54
55
56
57
58
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_WorkerTestUtils__
#define mozilla_dom_WorkerTestUtils__

#include "nsStringFwd.h"

namespace mozilla {

class ErrorResult;

namespace dom {

class GlobalObject;
class WorkerTestCallback;

/**
 * dom/webidl/WorkerTestUtils.webidl defines APIs to expose worker's internal
 * status for glass-box testing. The APIs are only exposed to Workers with prefs
 * dom.workers.testing.enabled.
 *
 * WorkerTestUtils is the implementation of dom/webidl/WorkerTestUtils.webidl
 */
class WorkerTestUtils final {
 public:
  /**
   *  Expose the worker's current timer nesting level.
   *
   *  The worker's current timer nesting level means the executing timer
   *  handler's timer nesting level. When there is no executing timer handler, 0
   *  should be returned by this API. The maximum timer nesting level is 5.
   *
   *  https://html.spec.whatwg.org/#timer-initialisation-steps
   */
  static uint32_t CurrentTimerNestingLevel(const GlobalObject&,
                                           ErrorResult& aErr);

  static bool IsRunningInBackground(const GlobalObject&, ErrorResult& aErr);

  static void HoldStrongWorkerRefUntilMainThreadObserverNotified(
      const GlobalObject&, const nsACString& aTopic, ErrorResult& aErr);

  MOZ_CAN_RUN_SCRIPT static void BlockUntilMainThreadObserverNotified(
      const GlobalObject&, const nsACString& aTopic,
      WorkerTestCallback& aWhenObserving, ErrorResult& aErr);

  static void NotifyObserverOnMainThread(const GlobalObject&,
                                         const nsACString& aTopic,
                                         ErrorResult& aErr);
};

}  // namespace dom
}  // namespace mozilla
#endif