firefox-main/dom/workers
Name Description Size Coverage
ChromeWorker.cpp static 3116 -
ChromeWorker.h unused 1077 -
ChromeWorkerScope.cpp 1886 -
ChromeWorkerScope.h 643 -
EventWithOptionsRunnable.cpp 4813 -
EventWithOptionsRunnable.h 2165 -
JSExecutionManager.cpp 7199 -
JSExecutionManager.h 6930 -
JSSettings.h 1819 -
loader -
MessageEventRunnable.cpp 6442 -
MessageEventRunnable.h 1752 -
metrics.yaml 2840 -
moz.build 2663 -
nsIWorkerChannelInfo.idl 847 -
nsIWorkerDebugger.idl 2435 -
nsIWorkerDebuggerManager.idl 836 -
Queue.h mozilla_dom_workerinternals_Queue_h 3754 -
RegisterBindings.cpp 1486 -
remoteworkers -
RuntimeService.cpp 83931 -
RuntimeService.h 5749 -
ScriptLoader.cpp 69871 -
ScriptLoader.h 13917 -
sharedworkers -
test -
Worker.cpp static 9016 -
Worker.h mozilla_dom_Worker_h 4173 -
WorkerChannelInfo.cpp 1890 -
WorkerChannelInfo.h 1363 -
WorkerCommon.h 2146 -
WorkerCSPContext.cpp static 3100 -
WorkerCSPContext.h 1705 -
WorkerCSPEventListener.cpp static 3094 -
WorkerCSPEventListener.h 1100 -
WorkerDebugger.cpp 13931 -
WorkerDebugger.h 1691 -
WorkerDebuggerManager.cpp anonymous namespace 10763 -
WorkerDebuggerManager.h 3366 -
WorkerDocumentListener.cpp 3530 -
WorkerDocumentListener.h mozilla_dom_WorkerDocumentListener_h_ 1150 -
WorkerError.cpp isErrorEvent 15738 -
WorkerError.h 2521 -
WorkerEventTarget.cpp 8273 -
WorkerEventTarget.h 1708 -
WorkerIPCUtils.h 1356 -
WorkerLoadInfo.cpp 16809 -
WorkerLoadInfo.h 5970 -
WorkerLocation.cpp static 1419 -
WorkerLocation.h 2488 -
WorkerNavigator.cpp static 10033 -
WorkerNavigator.h unused 3748 -
WorkerPrivate.cpp 225077 -
WorkerPrivate.h 61208 -
WorkerRef.cpp static 7388 -
WorkerRef.h If you want to play with a DOM Worker, you must know that it can go away at any time if nothing prevents its shutting down. This documentation helps to understand how to play with DOM Workers correctly. There are several reasons why a DOM Worker could go away. Here is the complete list: a. GC/CC - If the DOM Worker thread is idle and the Worker object is garbage collected, it goes away. b. The worker script can call self.close() c. The Worker object calls worker.terminate() d. Firefox is shutting down. When a DOM Worker goes away, it does several steps. See more in WorkerStatus.h. The DOM Worker thread will basically stop scheduling WorkerRunnables, and eventually WorkerControlRunnables. But if there is something preventing the shutting down, it will always possible to dispatch WorkerControlRunnables. Of course, at some point, the worker _must_ be released, otherwise firefox will leak it and the browser shutdown will hang. WeakWorkerRef is a refcounted, NON thread-safe object. From this object, you can obtain a WorkerPrivate, calling WeakWorkerRef::GetPrivate(). It returns nullptr if the worker is shutting down or if it is already gone away. If you want to know when a DOM Worker starts the shutting down procedure, pass a callback to the mozilla::dom::WeakWorkerRef::Create() method. Your function will be called. Note that _after_ the callback, WeakWorkerRef::GetPrivate() will return nullptr. How to keep a DOM Worker alive? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you need to keep the worker alive, you must use StrongWorkerRef. You can have this refcounted, NON thread-safe object, calling mozilla::dom::StrongWorkerRef::Create(WorkerPrivate* aWorkerPrivate); If you have a StrongWorkerRef: a. the DOM Worker is kept alive. b. you can have access to the WorkerPrivate, calling: Private(). c. WorkerControlRunnable can be dispatched. Note that the DOM Worker shutdown can start at any time, but having a StrongWorkerRef prevents the full shutdown. Also with StrongWorkerRef, you can pass a callback when calling mozilla::dom::StrongWorkerRef::Create(). When the DOM Worker shutdown starts, WorkerRunnable cannot be dispatched anymore. At this point, you should dispatch WorkerControlRunnable just to release resources. How to have a thread-safe DOM Worker reference? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Sometimes you need to play with threads and you need a thread-safe worker reference. ThreadSafeWorkerRef is what you want. Just because this object can be sent to different threads, we don't allow the setting of a callback. It would be confusing. ThreadSafeWorkerRef can be destroyed in any thread. Internally it keeps a reference to its StrongWorkerRef creator and this ref will be dropped on the correct thread when the ThreadSafeWorkerRef is deleted. IPC WorkerRef ~~~~~~~~~~~~~ IPDL protocols require a correct shutdown sequence. Because of this, they need a special configuration: 1. they need to be informed when the Worker starts the shutting down 2. they don't want to prevent the shutdown 3. but at the same time, they need to block the shutdown until the WorkerRef is not longer alive. Point 1 is a standard feature of WorkerRef; point 2 is similar to WeakWorkerRef; point 3 is similar to StrongWorkerRef. You can create a special IPC WorkerRef using this static method: mozilla::dom::IPCWorkerRef::Create(WorkerPrivate* aWorkerPrivate, const char* * aName); 9180 -
WorkerRunnable.cpp 25305 -
WorkerRunnable.h 20264 -
WorkerScope.cpp 52770 -
WorkerScope.h 20167 -
WorkerStatus.h Use this chart to help figure out behavior during each of the closing statuses. Details below. +========================================================+ | Closing Statuses | +=============+=============+=================+==========+ | status | clear queue | abort execution | notified | +=============+=============+=================+==========+ | Closing | yes | no | no | +-------------+-------------+-----------------+----------+ | Canceling | yes | yes | yes | +-------------+-------------+-----------------+----------+ | Killing | yes | yes | yes | +-------------+-------------+-----------------+----------+ 2185 -
WorkerTestUtils.cpp 5553 -
WorkerTestUtils.h 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 2000 -
WorkerThread.cpp aKey 10465 -
WorkerThread.h 3667 -