File: metric_report_queue.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (70 lines) | stat: -rw-r--r-- 2,176 bytes parent folder | download | duplicates (10)
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
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_REPORTING_METRICS_METRIC_REPORT_QUEUE_H_
#define COMPONENTS_REPORTING_METRICS_METRIC_REPORT_QUEUE_H_

#include <memory>
#include <string>

#include "base/functional/callback_helpers.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/time.h"
#include "components/reporting/client/report_queue.h"
#include "components/reporting/proto/synced/record_constants.pb.h"

namespace reporting {

class MetricData;
class MetricRateController;
class ReportingSettings;

// Simple wrapper for `::reporting::ReportQueue` that can be set for periodic
// upload.
class MetricReportQueue {
 public:
  MetricReportQueue(
      std::unique_ptr<ReportQueue, base::OnTaskRunnerDeleter> report_queue,
      Priority priority);

  // Constructor used if the reporter is needed to upload records periodically.
  MetricReportQueue(
      std::unique_ptr<ReportQueue, base::OnTaskRunnerDeleter> report_queue,
      Priority priority,
      ReportingSettings* reporting_settings,
      const std::string& rate_setting_path,
      base::TimeDelta default_rate,
      int rate_unit_to_ms = 1);

  MetricReportQueue() = delete;
  MetricReportQueue(const MetricReportQueue& other) = delete;
  MetricReportQueue& operator=(const MetricReportQueue& other) = delete;

  virtual ~MetricReportQueue();

  // Enqueue the metric data.
  virtual void Enqueue(
      MetricData metric_data,
      ReportQueue::EnqueueCallback callback = base::DoNothing());

  // Initiate manual upload of records with `priority_` and restart timer if
  // exists.
  void Upload();

  // Retrieves the reporting destination configured with the `report_queue_`.
  virtual Destination GetDestination() const;

 private:
  // Initiate upload of records with `priority_`.
  virtual void Flush();

  const std::unique_ptr<ReportQueue, base::OnTaskRunnerDeleter> report_queue_;

  const Priority priority_;

  std::unique_ptr<MetricRateController> rate_controller_;
};
}  // namespace reporting

#endif  // COMPONENTS_REPORTING_METRICS_METRIC_REPORT_QUEUE_H_