Interface nsIGleanTimespanType

Hierarchy

Methods

AddRef QueryInterface Release cancel setRaw start stop testGetValue

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

cancel

  • Aborts a previous start.

    Does not record an error if there was no previous call to start.

    Returns void

setRaw

  • Explicitly sets the timespan value.

    This API should only be used if you cannot make use of start/stop/cancel.

    Parameters

    • aDuration: uint32_t

      The duration of this timespan, in units matching the time_unit of this metric's definition.

    Returns void

start

  • Start tracking time for the provided metric.

    This records an error if it’s already tracking time (i.e. start was already called with no corresponding [stop]): in that case the original start time will be preserved.

    Returns void

stop

  • Stop tracking time for the provided metric.

    Sets the metric to the elapsed time, but does not overwrite an already existing value. This will record an error if no [start] was called or there is an already existing value.

    Returns void

testGetValue

  • Test-only API

    Gets the currently stored value as an integer.

    This function will attempt to await the last parent-process task (if any) writing to the the metric's storage engine before returning a value. This function will not wait for data from child processes.

    This doesn't clear the stored value. Parent process only. Panics in child processes.

    Returns

    value of the stored metric, or undefined if there is no value.

    Parameters

    • aPingName: string

      The (optional) name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc