Interface nsICachePurgeLockType

This object is a wrapper of MultiInstanceLock. It's intended to be used to ensure exclusive access to folders being deleted by the purgeHTTPCache background task.

Hierarchy

Methods

AddRef QueryInterface Release isOtherInstanceRunning lock unlock

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

isOtherInstanceRunning

  • Returns true if another instance also holds the lock. Throws if called before lock was called, or after unlock was called.

    Returns bool

lock

  • Initializes the lock using the profile name and the current process's path. Will throw if a lock was already acquired successfully.

    Parameters

    • profileName: string

    Returns void

unlock

  • Releases the lock. This object may be locked again, potentially using a different path after unlocking.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc