summaryrefslogtreecommitdiffstats
path: root/dom/base/UseCounterMetrics.h
blob: 65d4234d1eeb7f085d28ae4e8f86348f922e2641 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/* -*- 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
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef UseCounterMetrics_h_
#define UseCounterMetrics_h_

#include "stdint.h"

namespace mozilla {
enum UseCounter : int16_t;
enum class UseCounterWorker : int16_t;

namespace dom {
enum WorkerKind : uint8_t;

/**
 * Increments the metric associated with the specific use counter.
 *
 * @param aUseCounter - The use counter for the feature that was used.
 * @param aIsPage - Whether we should record to the page or document metric.
 * @returns The name of the metric that was incremented, or "".
 */
const char* IncrementUseCounter(UseCounter aUseCounter, bool aIsPage);

/**
 * Increments the metric associated with the specific worker use counter.
 *
 * @param aUseCounter - The use counter for the feature that was used.
 * @param aKind - The kind of worker that triggered the use counter.
 * @returns The name of the metric that was incremented, or "".
 */
const char* IncrementWorkerUseCounter(UseCounterWorker aUseCounter,
                                      WorkerKind aKind);

}  // namespace dom
}  // namespace mozilla

#endif  // UseCounterMetrics_h_