summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/core/TelemetryOrigin.h
blob: b0d372120058bcaf37fbd70d35182ee1da0f5b01 (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
/* -*- 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 TelemetryOrigin_h__
#define TelemetryOrigin_h__

#include "TelemetryOriginEnums.h"
#include "jsapi.h"
#include "nsError.h"
#include "nsString.h"

// This module is internal to Telemetry. It encapsulates Telemetry's
// origin recording and storage logic. It should only be used by
// Telemetry.cpp. These functions should not be used anywhere else.
// For the public interface to Telemetry functionality, see Telemetry.h.

namespace TelemetryOrigin {

void InitializeGlobalState();
void DeInitializeGlobalState();

// C++ Recording Endpoint
nsresult RecordOrigin(mozilla::Telemetry::OriginMetricID aId,
                      const nsACString& aOrigin);

// JS API Endpoints.
nsresult GetOriginSnapshot(bool aClear, JSContext* aCx,
                           JS::MutableHandleValue aResult);

nsresult GetEncodedOriginSnapshot(bool aClear, JSContext* aCx,
                                  JS::MutableHandleValue aSnapshot);

// Only to be used for testing.
void ClearOrigins();

size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf);

// Only to be used for testing.
size_t SizeOfPrioDatasPerMetric();

}  // namespace TelemetryOrigin

#endif  // TelemetryOrigin_h__