Interface nsIThreadShutdownType

Handle for the ongoing shutdown progress of a given thread which can be used to observe and interrupt async shutdown progress. Methods on this interface may generally only be used on the thread which called nsIThread::beginShutdown.

Hierarchy

Properties

completed: boolean

Check if the target thread has completed shutdown.

May only be accessed on the thread which called nsIThread::beginShutdown.

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Register a runnable to be executed when the thread has completed shutdown, or shutdown has been cancelled due to stopWaitingAndLeakThread().

    If the thread has already completed or cancelled shutdown, the runnable may be executed synchronously.

    May only be called on the thread which invoked nsIThread::beginShutdown.

    Parameters

    • aEvent: nsIRunnable

    Returns void

  • Give up on waiting for the shutting down thread to exit. Calling this method will allow the thread to continue running, no longer block shutdown, and the thread will never be joined or have its resources reclaimed.

    Completion callbacks attached to this nsIThreadShutdown may be executed during this call.

    This method should NOT be called except in exceptional circumstances during shutdown, as it will cause resources for the shutting down thread to be leaked.

    May only be called on the thread which called nsIThread::beginShutdown

    Throws

    NS_ERROR_NOT_AVAILABLE Indicates that the target thread has already stopped running and a request to be joined is already being dispatched to the waiting thread.

    Returns void

Generated using TypeDoc