Quantum/DOM - Revision history

Bevis Tseng: /* Q3: What runnables shall be labeled? */

2017-05-17T04:51:23Z

Q3: What runnables shall be labeled?

← Older revision		Revision as of 04:51, 17 May 2017
Line 280:		Line 280:
	* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' or the use of '''NS_NewInputStreamPump()'''. (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)		* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' or the use of '''NS_NewInputStreamPump()'''. (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)
	* The use of '''NS_ProxyRelease''' on main thread, '''NS_ReleaseOnMainThread''', or '''nsMainThreadPtrHolder'''.		* The use of '''NS_ProxyRelease''' on main thread, '''NS_ReleaseOnMainThread''', or '''nsMainThreadPtrHolder'''.
	* All '''[[Quantum/DOM#IPC_Actors\|IPC Actor Childs]]''' created on the main thread ~~has~~ to be labeled.		* All '''[[Quantum/DOM#IPC_Actors\|IPC Actor Childs]]''' created on the main thread have to be labeled.

	=== Q4: How do I specify a label for an nsITimer TimerCallback? ===		=== Q4: How do I specify a label for an nsITimer TimerCallback? ===

Bevis Tseng: /* Q3: What runnables shall be labeled? */

2017-05-17T04:50:44Z

Q3: What runnables shall be labeled?

← Older revision		Revision as of 04:50, 17 May 2017
Line 280:		Line 280:
	* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' or the use of '''NS_NewInputStreamPump()'''. (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)		* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' or the use of '''NS_NewInputStreamPump()'''. (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)
	* The use of '''NS_ProxyRelease''' on main thread, '''NS_ReleaseOnMainThread''', or '''nsMainThreadPtrHolder'''.		* The use of '''NS_ProxyRelease''' on main thread, '''NS_ReleaseOnMainThread''', or '''nsMainThreadPtrHolder'''.
			* All '''[[Quantum/DOM#IPC_Actors\|IPC Actor Childs]]''' created on the main thread has to be labeled.

	=== Q4: How do I specify a label for an nsITimer TimerCallback? ===		=== Q4: How do I specify a label for an nsITimer TimerCallback? ===

Bevis Tseng: /* Q3: What runnables shall be labeled? */

2017-05-17T03:22:27Z

Q3: What runnables shall be labeled?

← Older revision		Revision as of 03:22, 17 May 2017
Line 271:		Line 271:
	<b>A:</b> All the runnables dispatched to '''the main thread of the content process''' shall be labeled.		<b>A:</b> All the runnables dispatched to '''the main thread of the content process''' shall be labeled.

	In addition to '''NS_Dispatch(Main\|Current)Thread''', there are several ways to ~~trigger~~ a runnable to the main thread implicitly:		In addition to '''NS_Dispatch(Main\|Current)Thread''', there are several ways to dispatch a runnable to the main thread implicitly:

	* Any calls to the '''Dispatch()''' method of the subclass of '''nsIEventTarget'''.		* Any calls to the '''Dispatch()''' method of the subclass of '''nsIEventTarget'''.
Line 278:		Line 278:
	* Handled the received messages in '''IPC actor childs'''. (A received message will be handled on main thread with a new runnable if its actor child is created on the main thread.)		* Handled the received messages in '''IPC actor childs'''. (A received message will be handled on main thread with a new runnable if its actor child is created on the main thread.)
	* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)		* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)
	* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' . (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)		* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' or the use of '''NS_NewInputStreamPump()'''. (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)
	* The use of '''NS_ProxyRelease''' on main thread or '''~~NS_ReleaseOnMainThread~~'''.		* The use of '''NS_ProxyRelease''' on main thread, '''NS_ReleaseOnMainThread''', or '''nsMainThreadPtrHolder'''.

	=== Q4: How do I specify a label for an nsITimer TimerCallback? ===		=== Q4: How do I specify a label for an nsITimer TimerCallback? ===

Bevis Tseng: /* AbstractThread::MainThread */

2017-04-28T10:37:12Z

AbstractThread::MainThread

← Older revision		Revision as of 10:37, 28 April 2017
Line 217:		Line 217:

	== AbstractThread::MainThread ==		== AbstractThread::MainThread ==
	AbstractThread::MainThread() is a singleton of the AbstractThread wrapper class for the main thread and is widely used with MozPromise and its Promise-chain. If you use AbstractThread::MainThread() in your code and you have access to a document or a window, you can replace it with '''AbstractMainThreadFor''' provided the document or window object (or by TabGroup or DocGroup directly).		AbstractThread::MainThread() is a singleton of the AbstractThread wrapper class for the main thread and is widely used with MozPromise and its Promise-chain. If you use AbstractThread::MainThread() in your code and you have access to a document or a window, you can replace it with '''AbstractMainThreadFor''' provided by the document or window object (or by TabGroup or DocGroup directly).

	=== Example ===		=== Example ===

Bevis Tseng: /* Q3: What runnables shall be labeled? */

2017-04-26T03:12:14Z

Q3: What runnables shall be labeled?

← Older revision		Revision as of 03:12, 26 April 2017
Line 278:		Line 278:
	* Handled the received messages in '''IPC actor childs'''. (A received message will be handled on main thread with a new runnable if its actor child is created on the main thread.)		* Handled the received messages in '''IPC actor childs'''. (A received message will be handled on main thread with a new runnable if its actor child is created on the main thread.)
	* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)		* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)
	* The ~~use of '''NS_New(In\|Out)putStreamReadyEvent''' or the~~ use of '''AsyncWait()''' on ~~the~~ '''(In\|Out)putStream''' ~~acquired from '''new Pipe()''' in js or '''NS_NewPipe()''' in native implementaiton~~. (These 2 use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget ~~which needs~~ to be labeled if the nsIEventTarget points to the main thread.)		* The use of '''AsyncWait()''' on any '''nsIAsync(In\|Out)putStream''' . (These use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget in the invocation of AsyncWait(). These runnables need to be labeled if the nsIEventTarget points to the main thread.)
	* The use of '''NS_ProxyRelease''' on main thread or '''NS_ReleaseOnMainThread'''.		* The use of '''NS_ProxyRelease''' on main thread or '''NS_ReleaseOnMainThread'''.

Bevis Tseng: /* Q3: What runnables shall be labeled? */

2017-04-11T06:22:21Z

Q3: What runnables shall be labeled?

← Older revision		Revision as of 06:22, 11 April 2017
Line 279:		Line 279:
	* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)		* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)
	* The use of '''NS_New(In\|Out)putStreamReadyEvent''' or the use of '''AsyncWait()''' on the '''(In\|Out)putStream''' acquired from '''new Pipe()''' in js or '''NS_NewPipe()''' in native implementaiton. (These 2 use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget which needs to be labeled if the nsIEventTarget points to the main thread.)		* The use of '''NS_New(In\|Out)putStreamReadyEvent''' or the use of '''AsyncWait()''' on the '''(In\|Out)putStream''' acquired from '''new Pipe()''' in js or '''NS_NewPipe()''' in native implementaiton. (These 2 use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget which needs to be labeled if the nsIEventTarget points to the main thread.)
	* The use of '''NS_ProxyRelease''' on main thread or ~~NS_~~'''~~ReleaseOnMainThread~~'''.		* The use of '''NS_ProxyRelease''' on main thread or '''NS_ReleaseOnMainThread'''.

	=== Q4: How do I specify a label for an nsITimer TimerCallback? ===		=== Q4: How do I specify a label for an nsITimer TimerCallback? ===

Bevis Tseng: /* Q7: How to name an annoymous runnable before supporting (Doc|Tab|System)Group labeling? */

2017-04-10T09:06:22Z

Q7: How to name an annoymous runnable before supporting (Doc|Tab|System)Group labeling?

← Older revision		Revision as of 09:06, 10 April 2017
Line 300:		Line 300:
	* Subclasses of '''(Cancelable)Runnable''' classes which is displayed as "anonymous runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].		* Subclasses of '''(Cancelable)Runnable''' classes which is displayed as "anonymous runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].
	** To rename these runnables, you can invoke base classes constructor of '''(Cancelable)Runnable(const char* aName)''' in the subclass constructor.		** To rename these runnables, you can invoke base classes constructor of '''(Cancelable)Runnable(const char* aName)''' in the subclass constructor.
	** If your runnable instance was created from NewRunnableFunction(aFunction, ...) or NewRunnableMethod(aMethod, ...), you can call the the overloaded ~~function~~ of NewRunnableFunction(aName, ...) or NewRunnableMethod(aName, ...) to rename these runnables.		** If your runnable instance was created from '''NewRunnableFunction(aFunction, ...)''' or '''NewRunnableMethod(aMethod, ...)''', you can call the the overloaded functions of '''NewRunnableFunction(aName, ...)''' or '''NewRunnableMethod(aName, ...)''' to rename these runnables.
	* Subclasses of '''nsIRunnable''' but not '''Runnable''' classes which is displayed as "non-nsINamed runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].		* Subclasses of '''nsIRunnable''' but not '''Runnable''' classes which is displayed as "non-nsINamed runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].
	** To rename these runnables, you can either change the base class to '''Runnable''' or inherit '''nsINamed''' class and override its '''GetName''' method.		** To rename these runnables, you can either change the base class to '''Runnable''' or inherit '''nsINamed''' class and override its '''GetName''' method.
	* The timer callbacks of '''nsITimer::Init()''' or '''nsITimer::InitWith(FuncCallback\|Callback)''' which are displayed as "Anonymous_observer_timer", "Anonymous_callback_timer", and "Anonymous_interface_timer" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].		* The timer callbacks of '''nsITimer::Init()''' or '''nsITimer::InitWith(FuncCallback\|Callback)''' which are displayed as "Anonymous_observer_timer", "Anonymous_callback_timer", and "Anonymous_interface_timer" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].
	** To rename this timercallbacks, you can either have your nsISupport/nsIObserver class inheriting '''nsINamed''' class or call the named version of '''Timer::InitWith(NamedFuncCallback\|initWithNameableFuncCallback)''' for your nsTimerCallbackFunc instance.		** To rename this timercallbacks, you can either have your nsISupport/nsIObserver class inheriting '''nsINamed''' class or call the named version of '''Timer::InitWith(NamedFuncCallback\|initWithNameableFuncCallback)''' for your nsTimerCallbackFunc instance.

Bevis Tseng: /* Q7: How to name an annoymous runnable before supporting (Doc|Tab|System)Group labeling? */

2017-04-10T09:05:18Z

Q7: How to name an annoymous runnable before supporting (Doc|Tab|System)Group labeling?

← Older revision		Revision as of 09:05, 10 April 2017
Line 300:		Line 300:
	* Subclasses of '''(Cancelable)Runnable''' classes which is displayed as "anonymous runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].		* Subclasses of '''(Cancelable)Runnable''' classes which is displayed as "anonymous runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].
	** To rename these runnables, you can invoke base classes constructor of '''(Cancelable)Runnable(const char* aName)''' in the subclass constructor.		** To rename these runnables, you can invoke base classes constructor of '''(Cancelable)Runnable(const char* aName)''' in the subclass constructor.
			** If your runnable instance was created from NewRunnableFunction(aFunction, ...) or NewRunnableMethod(aMethod, ...), you can call the the overloaded function of NewRunnableFunction(aName, ...) or NewRunnableMethod(aName, ...) to rename these runnables.
	* Subclasses of '''nsIRunnable''' but not '''Runnable''' classes which is displayed as "non-nsINamed runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].		* Subclasses of '''nsIRunnable''' but not '''Runnable''' classes which is displayed as "non-nsINamed runnable" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].
	** To rename these runnables, you can either change the base class to '''Runnable''' or inherit '''nsINamed''' class and override its '''GetName''' method.		** To rename these runnables, you can either change the base class to '''Runnable''' or inherit '''nsINamed''' class and override its '''GetName''' method.
	* The timer callbacks of '''nsITimer::Init()''' or '''nsITimer::InitWith(FuncCallback\|Callback)''' which are displayed as "Anonymous_observer_timer", "Anonymous_callback_timer", and "Anonymous_interface_timer" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].		* The timer callbacks of '''nsITimer::Init()''' or '''nsITimer::InitWith(FuncCallback\|Callback)''' which are displayed as "Anonymous_observer_timer", "Anonymous_callback_timer", and "Anonymous_interface_timer" in the runnable analysis of [https://bugzilla.mozilla.org/show_bug.cgi?id=1333984 bug 1333984].
	** To rename this timercallbacks, you can either have your nsISupport/nsIObserver class inheriting '''nsINamed''' class or call the named version of '''Timer::InitWith(NamedFuncCallback\|initWithNameableFuncCallback)''' for your nsTimerCallbackFunc instance.		** To rename this timercallbacks, you can either have your nsISupport/nsIObserver class inheriting '''nsINamed''' class or call the named version of '''Timer::InitWith(NamedFuncCallback\|initWithNameableFuncCallback)''' for your nsTimerCallbackFunc instance.

Bevis Tseng: Q7: How to name an annoymous runnable before supporting (Doc|Tab|System)Group labeling?

2017-04-10T08:25:02Z

Q7: How to name an annoymous runnable before supporting (Doc|Tab|System)Group labeling?

@@ Line 279: / Line 279: @@
 * Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)
 * The use of '''NS_New(In|Out)putStreamReadyEvent''' or the use of '''AsyncWait()''' on the '''(In|Out)putStream''' acquired from '''new Pipe()''' in js or '''NS_NewPipe()''' in native implementaiton. (These 2 use cases trigger new runnables named '''(In|Out)putStreamReadyEvent''' to the specified nsIEventTarget which needs to be labeled if the nsIEventTarget points to the main thread.)
 === Q4: How do I specify a label for an nsITimer TimerCallback? ===
@@ Line 293: / Line 294: @@
 <b>A:</b> No. Only content process runnables need to be labeled. But labeling other runnables won't break anything.

Bevis Tseng: /* Q3: What runnables shall be labeled? */

2017-04-10T06:43:55Z

Q3: What runnables shall be labeled?

← Older revision		Revision as of 06:43, 10 April 2017
Line 278:		Line 278:
	* Handled the received messages in '''IPC actor childs'''. (A received message will be handled on main thread with a new runnable if its actor child is created on the main thread.)		* Handled the received messages in '''IPC actor childs'''. (A received message will be handled on main thread with a new runnable if its actor child is created on the main thread.)
	* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)		* Subclass of '''nsExpirationTracker''' (The overriden method of NotifyExpired() will be triggered implicitly with a new runnable by the internal timer in nsExpirationTracker implementation. See the dependency tree of [https://bugzilla.mozilla.org/show_bug.cgi?id=1345464 bug 1345464] for the list of the sub-classes.)
	* The use of '''NS_New(In\|Out)putStreamReadyEvent''' or the use of '''AsyncWait() on the (In\|Out)putStream acquired from new Pipe() in js or NS_NewPipe() in native implementaiton~~'''~~. (These 2 use cases trigger new runnables '''~~named~~ (In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget which needs to be labeled if the nsIEventTarget points to the main thread.)		* The use of '''NS_New(In\|Out)putStreamReadyEvent''' or the use of '''AsyncWait()''' on the '''(In\|Out)putStream''' acquired from '''new Pipe()''' in js or '''NS_NewPipe()''' in native implementaiton. (These 2 use cases trigger new runnables named '''(In\|Out)putStreamReadyEvent''' to the specified nsIEventTarget which needs to be labeled if the nsIEventTarget points to the main thread.)

	=== Q4: How do I specify a label for an nsITimer TimerCallback? ===		=== Q4: How do I specify a label for an nsITimer TimerCallback? ===