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 | 14 |
14 namespace metrics { | 15 namespace metrics { |
15 | 16 |
16 // Scheduler task to drive a MetricsService object's uploading. | 17 // Scheduler task to drive a MetricsService object's uploading. |
17 class MetricsReportingScheduler { | 18 class MetricsReportingScheduler { |
18 public: | 19 public: |
19 explicit MetricsReportingScheduler(const base::Closure& upload_callback); | 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); | |
20 ~MetricsReportingScheduler(); | 26 ~MetricsReportingScheduler(); |
21 | 27 |
22 // Starts scheduling uploads. This in a no-op if the scheduler is already | 28 // Starts scheduling uploads. This in a no-op if the scheduler is already |
23 // running, so it is safe to call more than once. | 29 // running, so it is safe to call more than once. |
24 void Start(); | 30 void Start(); |
25 | 31 |
26 // Stops scheduling uploads. | 32 // Stops scheduling uploads. |
27 void Stop(); | 33 void Stop(); |
28 | 34 |
29 // Callback from MetricsService when the startup init task has completed. | 35 // Callback from MetricsService when the startup init task has completed. |
30 void InitTaskComplete(); | 36 void InitTaskComplete(); |
31 | 37 |
32 // Callback from MetricsService when a triggered upload finishes. | 38 // Callback from MetricsService when a triggered upload finishes. |
33 void UploadFinished(bool server_is_healthy, bool more_logs_remaining); | 39 void UploadFinished(bool server_is_healthy, bool more_logs_remaining); |
34 | 40 |
35 // Callback from MetricsService when a triggered upload is cancelled by the | 41 // Callback from MetricsService when a triggered upload is cancelled by the |
36 // MetricsService. | 42 // MetricsService. |
37 void UploadCancelled(); | 43 void UploadCancelled(); |
38 | 44 |
39 // Sets the upload interval to a specific value, exposed for unit tests. | 45 // Sets the upload interval to a specific value, exposed for unit tests. |
40 void SetUploadIntervalForTesting(base::TimeDelta interval); | 46 void SetUploadIntervalForTesting(base::TimeDelta interval); |
41 | 47 |
48 // Sets whether the network connection is cellular or not. | |
49 void SetConnectionType(bool is_cellular); | |
50 | |
42 private: | 51 private: |
43 // Timer callback indicating it's time for the MetricsService to upload | 52 // Timer callback indicating it's time for the MetricsService to upload |
44 // metrics. | 53 // metrics. |
45 void TriggerUpload(); | 54 void TriggerUpload(); |
46 | 55 |
47 // Schedules a future call to TriggerUpload if one isn't already pending. | 56 // Schedules a future call to TriggerUpload if one isn't already pending. |
48 void ScheduleNextUpload(); | 57 void ScheduleNextUpload(); |
49 | 58 |
50 // Increases the upload interval each time it's called, to handle the case | 59 // Increases the upload interval each time it's called, to handle the case |
51 // where the server is having issues. | 60 // where the server is having issues. |
52 void BackOffUploadInterval(); | 61 void BackOffUploadInterval(); |
53 | 62 |
54 // Returns upload interval based on the system and experiment that the user is | 63 // Returns upload interval based on the system and experiment that the user is |
55 // assigned to. | 64 // assigned to. |
56 // TODO(gayane): Only for experimenting with upload interval for Android | 65 // TODO(gayane): Only for experimenting with upload interval for Android |
57 // (bug: 17391128). Should be removed once the experiments are done. | 66 // (bug: 17391128). Should be removed once the experiments are done. |
58 base::TimeDelta GetStandardUploadInterval(); | 67 base::TimeDelta GetStandardUploadInterval(); |
59 | 68 |
69 // Returns true if the user is assigned to the experiment group for enabled | |
70 // cellular uploads. | |
71 bool IsCellularEnabledByExperiment(); | |
Alexei Svitkine (slow)
2015/02/18 03:26:23
Make this an anon function inside the .cc.
gayane -on leave until 09-2017
2015/02/18 21:38:23
Done.
| |
72 | |
60 // The MetricsService method to call when uploading should happen. | 73 // The MetricsService method to call when uploading should happen. |
61 const base::Closure upload_callback_; | 74 const base::Closure upload_callback_; |
62 | 75 |
63 base::OneShotTimer<MetricsReportingScheduler> upload_timer_; | 76 base::OneShotTimer<MetricsReportingScheduler> upload_timer_; |
64 | 77 |
65 // The interval between being told an upload is done and starting the next | 78 // The interval between being told an upload is done and starting the next |
66 // upload. | 79 // upload. |
67 base::TimeDelta upload_interval_; | 80 base::TimeDelta upload_interval_; |
68 | 81 |
69 // The tick count of the last time log upload has been finished and null if no | 82 // The tick count of the last time log upload has been finished and null if no |
70 // upload has been done yet. | 83 // upload has been done yet. |
71 base::TimeTicks last_upload_finish_time_; | 84 base::TimeTicks last_upload_finish_time_; |
72 | 85 |
73 // Indicates that the scheduler is running (i.e., that Start has been called | 86 // Indicates that the scheduler is running (i.e., that Start has been called |
74 // more recently than Stop). | 87 // more recently than Stop). |
75 bool running_; | 88 bool running_; |
76 | 89 |
77 // Indicates that the last triggered upload hasn't resolved yet. | 90 // Indicates that the last triggered upload hasn't resolved yet. |
78 bool callback_pending_; | 91 bool callback_pending_; |
79 | 92 |
80 // Whether the InitTaskComplete() callback has been called. | 93 // Whether the InitTaskComplete() callback has been called. |
81 bool init_task_complete_; | 94 bool init_task_complete_; |
82 | 95 |
83 // Whether the initial scheduled upload timer has fired before the init task | 96 // Whether the initial scheduled upload timer has fired before the init task |
84 // has been completed. | 97 // has been completed. |
85 bool waiting_for_init_task_complete_; | 98 bool waiting_for_init_task_complete_; |
86 | 99 |
100 // Callback function from MetricsService used to get current network | |
101 // connection type. | |
102 base::Callback<void(bool*)> cellular_callback_; | |
103 | |
104 // Indicates whether network connection is cellular or not. | |
105 // Default value is |true| because cellular mode is more conservative. | |
106 bool is_cellular_connection_; | |
107 | |
87 DISALLOW_COPY_AND_ASSIGN(MetricsReportingScheduler); | 108 DISALLOW_COPY_AND_ASSIGN(MetricsReportingScheduler); |
88 }; | 109 }; |
89 | 110 |
90 } // namespace metrics | 111 } // namespace metrics |
91 | 112 |
92 #endif // COMPONENTS_METRICS_METRICS_REPORTING_SCHEDULER_H_ | 113 #endif // COMPONENTS_METRICS_METRICS_REPORTING_SCHEDULER_H_ |
OLD | NEW |