Interface nsIGleanTimingDistributionType

Hierarchy

Methods

AddRef QueryInterface Release cancel start stopAndAccumulate testAccumulateRawMillis 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 call. No error is recorded if no start was called. (But then where did you get that id from?)

    Parameters

    • aId: uint64_t

      The TimerID whose start you wish to abort.

    Returns void

start

  • Starts tracking time for the provided metric.

    Returns

    A unique timer id for the new timer

    Returns any

stopAndAccumulate

  • Stops tracking time for the provided metric and timer id.

    Adds a count to the corresponding bucket in the timing distribution. This will record an error if no start was called for this TimerId or if this TimerId was used to call cancel.

    Parameters

    • aId: uint64_t

      The TimerId associated with this timing. This allows for concurrent timing of events associated with different ids.

    Returns void

testAccumulateRawMillis

  • Test-only API

    Accumulates a raw numeric sample of milliseconds.

    Test-only until we find a use-case and decent JS Time Duration type.

    Parameters

    • aSample: uint64_t

      The sample, in milliseconds, to add.

    Returns void

testGetValue

  • Test-only API

    Gets the currently stored value as a DistributionData.

    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