Struct xpcom::interfaces::nsIAsyncShutdownBlocker [] [src]

#[repr(C)]
pub struct nsIAsyncShutdownBlocker { /* fields omitted */ }

interface nsIAsyncShutdownBlocker : nsISupports

/**
 * 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).
 */

Methods

impl nsIAsyncShutdownBlocker
[src]

[src]

Cast this nsIAsyncShutdownBlocker to one of its base interfaces.

impl nsIAsyncShutdownBlocker
[src]

[src]

/**
   * 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 attribute AString name;

[src]

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

void blockShutdown (in nsIAsyncShutdownClient aBarrierClient);

[src]

/**
   * 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).
   */

readonly attribute nsIPropertyBag state;

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIAsyncShutdownBlocker
[src]

IID: nsIID = nsID(1324629801, 26389, 19287, [167, 80, 47, 248, 54, 149, 221, 206])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIAsyncShutdownBlocker
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIAsyncShutdownBlocker
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.