Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
#ifndef mozilla_glean_GleanTimespan_h
#define mozilla_glean_GleanTimespan_h
#include "mozilla/Maybe.h"
#include "mozilla/Result.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/glean/bindings/GleanMetric.h"
#include "nsTString.h"
namespace mozilla::glean {
namespace impl {
class TimespanMetric {
public:
constexpr explicit TimespanMetric(uint32_t aId) : mId(aId) {}
/**
* 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.
*/
void Start() const;
/**
* 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.
*/
void Stop() const;
/**
* Abort a previous Start.
*
* No error will be recorded if no Start was called.
*/
void Cancel() const;
/**
* Explicitly sets the timespan value
*
* This API should only be used if you cannot make use of
* `start`/`stop`/`cancel`.
*
* @param aDuration The duration of this timespan, in units matching the
* `time_unit` of this metric's definition.
*/
void SetRaw(uint32_t aDuration) const;
/**
* **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.
*
* @param aPingName The (optional) name of the ping to retrieve the metric
* for. Defaults to the first value in `send_in_pings`.
*
* @return value of the stored metric, or Nothing() if there is no value.
*/
Result<Maybe<uint64_t>, nsCString> TestGetValue(
const nsACString& aPingName = nsCString()) const;
private:
const uint32_t mId;
};
} // namespace impl
class GleanTimespan final : public GleanMetric {
public:
explicit GleanTimespan(uint32_t aId, nsISupports* aParent)
: GleanMetric(aParent), mTimespan(aId) {}
virtual JSObject* WrapObject(
JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override final;
void Start();
void Stop();
void Cancel();
void SetRaw(uint32_t aDuration);
dom::Nullable<uint64_t> TestGetValue(const nsACString& aPingName,
ErrorResult& aRv);
private:
virtual ~GleanTimespan() = default;
const impl::TimespanMetric mTimespan;
};
} // namespace mozilla::glean
#endif /* mozilla_glean_GleanTimespan_h */