summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/core/Stopwatch.h
blob: 070872e250fb04cf0869bd093bd58e75a92fd20f (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
/* 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 Stopwatch_h__
#define Stopwatch_h__

#include "mozilla/dom/TelemetryStopwatchBinding.h"

namespace mozilla {
namespace telemetry {

class Stopwatch {
  using GlobalObject = mozilla::dom::GlobalObject;

 public:
  static bool Start(const GlobalObject& global, const nsAString& histogram,
                    JS::Handle<JSObject*> obj,
                    const dom::TelemetryStopwatchOptions& options);

  static bool Running(const GlobalObject& global, const nsAString& histogram,
                      JS::Handle<JSObject*> obj);

  static bool Cancel(const GlobalObject& global, const nsAString& histogram,
                     JS::Handle<JSObject*> obj);

  static int32_t TimeElapsed(const GlobalObject& global,
                             const nsAString& histogram,
                             JS::Handle<JSObject*> obj, bool canceledOkay);

  static bool Finish(const GlobalObject& global, const nsAString& histogram,
                     JS::Handle<JSObject*> obj, bool canceledOkay);

  static bool StartKeyed(const GlobalObject& global, const nsAString& histogram,
                         const nsAString& key, JS::Handle<JSObject*> obj,
                         const dom::TelemetryStopwatchOptions& options);

  static bool RunningKeyed(const GlobalObject& global,
                           const nsAString& histogram, const nsAString& key,
                           JS::Handle<JSObject*> obj);

  static bool CancelKeyed(const GlobalObject& global,
                          const nsAString& histogram, const nsAString& key,
                          JS::Handle<JSObject*> obj);

  static int32_t TimeElapsedKeyed(const GlobalObject& global,
                                  const nsAString& histogram,
                                  const nsAString& key,
                                  JS::Handle<JSObject*> obj, bool canceledOkay);

  static bool FinishKeyed(const GlobalObject& global,
                          const nsAString& histogram, const nsAString& key,
                          JS::Handle<JSObject*> obj, bool canceledOkay);

  static void SetTestModeEnabled(const GlobalObject& global, bool testing);
};

class UserInteractionStopwatch {
  using GlobalObject = mozilla::dom::GlobalObject;

 public:
  static bool Start(const GlobalObject& aGlobal,
                    const nsAString& aUserInteraction, const nsACString& aValue,
                    JS::Handle<JSObject*> aObj);
  static bool Running(const GlobalObject& aGlobal,
                      const nsAString& aUserInteraction,
                      JS::Handle<JSObject*> aObj);
  static bool Update(const GlobalObject& aGlobal,
                     const nsAString& aUserInteraction,
                     const nsACString& aValue, JS::Handle<JSObject*> aObj);
  static bool Cancel(const GlobalObject& aGlobal,
                     const nsAString& aUserInteraction,
                     JS::Handle<JSObject*> aObj);
  static bool Finish(const GlobalObject& aGlobal,
                     const nsAString& aUserInteraction,
                     JS::Handle<JSObject*> aObj,
                     const dom::Optional<nsACString>& aAdditionalText);
};

}  // namespace telemetry
}  // namespace mozilla

#endif  // Stopwatch_h__