Interface nsIAsyncShutdownBlockerType

A blocker installed by a client to be informed during some stage of shutdown and block shutdown asynchronously until some condition is complete.

If you wish to use AsyncShutdown, you will need to implement this interface (and only this interface).

Hierarchy

Properties

name state

Methods

AddRef QueryInterface Release blockShutdown

Properties

Readonly name

name: string

The unique name of the blocker.

By convention, it should respect the following format: "MyModuleName: Doing something while it's time" e.g. "OS.File: Flushing before profile-before-change"

This attribute is uploaded as part of crash reports.

Readonly state

state: nsIPropertyBag

The current state of the blocker.

In case of crash, this is converted to JSON and attached to the crash report.

This field may be used to provide JSON-style data structures. For this purpose, use

  • nsIPropertyBag to represent objects;
  • nsIVariant to represent field values (which may hold nsIPropertyBag themselves).

Methods

AddRef

  • 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

QueryInterface

  • 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

Release

  • 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

blockShutdown

  • Inform the blocker that the stage of shutdown has started. Shutdown will NOT proceed until aBarrierClient.removeBlocker(this) has been called.

    Parameters

    • aBarrierClient: nsIAsyncShutdownClient

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc