components/metrics/metrics_reporting_scheduler.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_METRICS_METRICS_REPORTING_SCHEDULER_H_
   6 #define COMPONENTS_METRICS_METRICS_REPORTING_SCHEDULER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/callback.h"
  10 #include "base/memory/weak_ptr.h"
  11 #include "base/time/time.h"
  12 #include "base/timer/timer.h"
  13 #include "components/metrics/net/network_metrics_provider.h"
  14
  15 namespace metrics {
  16
  17 // Scheduler task to drive a MetricsService object's uploading.
  18 class MetricsReportingScheduler {
  19  public:
  20   // Creates MetricsServiceScheduler object with the given |upload_callback|
  21   // callback to call when uploading should happen and |cellular_callback|
  22   // callback to get current network connection type.
  23   MetricsReportingScheduler(
  24       const base::Closure& upload_callback,
  25       const base::Callback<void(bool*)>& cellular_callback);
  26   ~MetricsReportingScheduler();
  27
  28   // Starts scheduling uploads. This in a no-op if the scheduler is already
  29   // running, so it is safe to call more than once.
  30   void Start();
  31
  32   // Stops scheduling uploads.
  33   void Stop();
  34
  35   // Callback from MetricsService when the startup init task has completed.
  36   void InitTaskComplete();
  37
  38   // Callback from MetricsService when a triggered upload finishes.
  39   void UploadFinished(bool server_is_healthy, bool more_logs_remaining);
  40
  41   // Callback from MetricsService when a triggered upload is cancelled by the
  42   // MetricsService.
  43   void UploadCancelled();
  44
  45   // Sets the upload interval to a specific value, exposed for unit tests.
  46   void SetUploadIntervalForTesting(base::TimeDelta interval);
  47
  48  private:
  49   // Timer callback indicating it's time for the MetricsService to upload
  50   // metrics.
  51   void TriggerUpload();
  52
  53   // Schedules a future call to TriggerUpload if one isn't already pending.
  54   void ScheduleNextUpload();
  55
  56   // Increases the upload interval each time it's called, to handle the case
  57   // where the server is having issues.
  58   void BackOffUploadInterval();
  59
  60   // Returns upload interval based on the system and experiment that the user is
  61   // assigned to.
  62   // TODO(gayane): Only for experimenting with upload interval for Android
  63   // (bug: 17391128). Should be removed once the experiments are done.
  64   base::TimeDelta GetStandardUploadInterval();
  65
  66   // The MetricsService method to call when uploading should happen.
  67   const base::Closure upload_callback_;
  68
  69   base::OneShotTimer<MetricsReportingScheduler> upload_timer_;
  70
  71   // The interval between being told an upload is done and starting the next
  72   // upload.
  73   base::TimeDelta upload_interval_;
  74
  75   // The tick count of the last time log upload has been finished and null if no
  76   // upload has been done yet.
  77   base::TimeTicks last_upload_finish_time_;
  78
  79   // Indicates that the scheduler is running (i.e., that Start has been called
  80   // more recently than Stop).
  81   bool running_;
  82
  83   // Indicates that the last triggered upload hasn't resolved yet.
  84   bool callback_pending_;
  85
  86   // Whether the InitTaskComplete() callback has been called.
  87   bool init_task_complete_;
  88
  89   // Whether the initial scheduled upload timer has fired before the init task
  90   // has been completed.
  91   bool waiting_for_init_task_complete_;
  92
  93   // Callback function used to get current network connection type.
  94   base::Callback<void(bool*)> cellular_callback_;
  95
  96   DISALLOW_COPY_AND_ASSIGN(MetricsReportingScheduler);
  97 };
  98
  99 }  // namespace metrics
 100
 101 #endif  // COMPONENTS_METRICS_METRICS_REPORTING_SCHEDULER_H_