File: WorkerTestUtils.webidl

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 (38 lines) | stat: -rw-r--r-- 1,809 bytes parent folder | download | duplicates (12)
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
/* 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/. */

callback WorkerTestCallback = undefined ();

[Exposed=Worker, Pref="dom.workers.testing.enabled"]
namespace WorkerTestUtils {
  [Throws]
  unsigned long currentTimerNestingLevel();
  [Throws]
  boolean IsRunningInBackground();

  // Mint a (ThreadSafe)StrongWorkerRef and hold it until we see an observer
  // notification with the given string topic on the main thread.  The
  // StrongWorkerRef will prevent the worker from moving from the Canceling to
  // the Killing state and thereby prevent it from shutting down.
  [Throws]
  undefined holdStrongWorkerRefUntilMainThreadObserverNotified(UTF8String topic);

  // Create a monitor that blocks the worker entirely until we see an observer
  // notification with the given string topic on the main thread.  This is a
  // much more drastic variant of
  // holdStrongWorkerRefUntilMainThreadObserverNotified for when the goal is to
  // avoid letting WorkerRefs be notified.  A callback should be passed to be
  // synchronously invoked once the observer has been registered in order to
  // communicate that the test can move forward.
  [Throws]
  undefined blockUntilMainThreadObserverNotified(UTF8String topic,
                                                 WorkerTestCallback whenObserving);

  // Dispatch a runnable to the main thread to notify the observer service with
  // the given topic.  This is primarily intended for use with
  // `holdStrongWorkerRefUntilMainThreadObserverNotified` but might be useful in
  // other situations to cut down on test boilerplate.
  [Throws]
  undefined notifyObserverOnMainThread(UTF8String topic);
};