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