nsIThreadManager Interface Reference

An interface for creating and locating nsIThread instances. More...

import "nsIThreadManager.idl";

Collaboration diagram for nsIThreadManager:

List of all members.

Public Member Functions
nsIThread	newThread (in unsigned long creationFlags)
	Create a new thread (a global, user PRThread).
nsIThread	getThreadFromPRThread (in PRThread prthread)
	Get the nsIThread object (if any) corresponding to the given PRThread.
Public Attributes
readonly attribute nsIThread	mainThread
	Get the main thread.
readonly attribute nsIThread	currentThread
	Get the current thread.
readonly attribute boolean	isMainThread
	This attribute is true if the calling thread is the main thread of the application process.
readonly attribute boolean	isCycleCollectorThread
	This attribute is true if the calling thread is the thread on which the cycle collector runs.

---

Detailed Description

An interface for creating and locating nsIThread instances.

---

Member Function Documentation

nsIThread nsIThreadManager::getThreadFromPRThread

(

in PRThread

prthread

)

Get the nsIThread object (if any) corresponding to the given PRThread.

This method returns null if there is no corresponding nsIThread.

Parameters:

prthread

The PRThread of the nsIThread being requested.

Returns:

The nsIThread object corresponding to the given PRThread or null if no such nsIThread exists.

nsIThread nsIThreadManager::newThread

(

in unsigned long

creationFlags

)

Create a new thread (a global, user PRThread).

Parameters:

creationFlags

Reserved for future use. Pass 0.

Returns:

The newly created nsIThread object.

---

Member Data Documentation

readonly attribute nsIThread nsIThreadManager::currentThread

Get the current thread.

If the calling thread does not already have a nsIThread associated with it, then a new nsIThread will be created and associated with the current PRThread.

readonly attribute boolean nsIThreadManager::isCycleCollectorThread

This attribute is true if the calling thread is the thread on which the cycle collector runs.

readonly attribute boolean nsIThreadManager::isMainThread

This attribute is true if the calling thread is the main thread of the application process.

readonly attribute nsIThread nsIThreadManager::mainThread

Get the main thread.

---

The documentation for this interface was generated from the following file:

• nsIThreadManager.idl