Interface nsIIdlePeriodType

An instance implementing nsIIdlePeriod is used by an associated nsIThread to estimate when it is likely that it will receive an event.

Hierarchy

Methods

AddRef QueryInterface Release getIdlePeriodHint

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

getIdlePeriodHint

  • Return an estimate of a point in time in the future when we think that the associated thread will become busy. Should return TimeStamp() (i.e. the null time) or a time less than TimeStamp::Now() if the thread is currently busy or will become busy very soon.

    Returns TimeStamp

Settings

Member Visibility

Theme

Generated using TypeDoc