Index: components/data_usage/android/traffic_stats_amortizer.h |
diff --git a/components/data_usage/android/traffic_stats_amortizer.h b/components/data_usage/android/traffic_stats_amortizer.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..50f8d4498cf81ba6821ca74ccc717709e76c9951 |
--- /dev/null |
+++ b/components/data_usage/android/traffic_stats_amortizer.h |
@@ -0,0 +1,152 @@ |
+// Copyright 2015 The Chromium Authors. All rights reserved. |
+// Use of this source code is governed by a BSD-style license that can be |
+// found in the LICENSE file. |
+ |
+#ifndef COMPONENTS_DATA_USAGE_ANDROID_TRAFFIC_STATS_AMORTIZER_H_ |
+#define COMPONENTS_DATA_USAGE_ANDROID_TRAFFIC_STATS_AMORTIZER_H_ |
+ |
+#include <stdint.h> |
+ |
+#include <utility> |
+#include <vector> |
+ |
+#include "base/macros.h" |
+#include "base/memory/linked_ptr.h" |
+#include "base/memory/scoped_ptr.h" |
+#include "base/memory/weak_ptr.h" |
+#include "base/threading/thread_checker.h" |
+#include "base/time/time.h" |
+#include "components/data_usage/core/data_use_amortizer.h" |
+ |
+namespace base { |
+class TickClock; |
+class Timer; |
+} |
+ |
+namespace data_usage { |
+ |
+struct DataUse; |
+ |
+namespace android { |
+ |
+// Class that uses Android TrafficStats to amortize any unincluded overhead into |
bengr
2015/11/11 15:41:38
It's worth mentioning that TrafficStats has been a
sclittle
2015/11/11 20:02:20
Done.
|
+// the data usage reported by the network stack. Should only be used on the IO |
+// thread. Since TrafficStats measurements are global for the entire |
+// application, a TrafficStatsAmortizer should be notified of every byte |
+// possible, or else it might mistakenly classify the corresponding additional |
+// TrafficStats bytes for those as overhead. |
bengr
2015/11/11 15:41:38
Please list the sources of this overhead: network
sclittle
2015/11/11 20:02:21
Done.
|
+class TrafficStatsAmortizer : public DataUseAmortizer { |
+ public: |
+ TrafficStatsAmortizer(); |
+ ~TrafficStatsAmortizer() override; |
+ |
+ // Amortizes any unincluded network bytes overhead for |data_use| into |
+ // |data_use|, and passes the updated |data_use| to |callback| once |
+ // amortization is complete. |
+ void AmortizeDataUse(scoped_ptr<DataUse> data_use, |
+ const AmortizationCompleteCallback& callback) override; |
+ |
+ // Notifies the DataUseAmortizer that some extra bytes have happened that |
bengr
2015/11/11 15:41:38
have happened -> have been transferred
sclittle
2015/11/11 20:02:20
Done.
|
+ // aren't associated with any DataUse objects (e.g. off-the-record traffic). |
+ void OnExtraBytes(int64_t extra_tx_bytes, int64_t extra_rx_bytes) override; |
bengr
2015/11/11 15:41:38
This reports bytes that are measured, but that are
sclittle
2015/11/11 20:02:20
Ack, I'll keep it as it is then.
|
+ |
+ base::WeakPtr<TrafficStatsAmortizer> GetWeakPtr(); |
+ |
+ protected: |
+ // Constructor for testing purposes, allowing for tests to take full control |
+ // over the timing of the TrafficStatsAmortizer and the byte counts returned |
+ // from TrafficStats. |traffic_stats_query_timer| must not be a repeating |
+ // timer. |
+ TrafficStatsAmortizer(scoped_ptr<base::TickClock> tick_clock, |
+ scoped_ptr<base::Timer> traffic_stats_query_timer, |
+ const base::TimeDelta& traffic_stats_query_delay, |
+ const base::TimeDelta& max_amortization_delay, |
+ size_t max_data_use_buffer_size); |
+ |
+ // Query the total transmitted and received bytes for the application from |
bengr
2015/11/11 15:41:38
Query -> Queries
sclittle
2015/11/11 20:02:20
Done.
|
+ // TrafficStats. Stores the byte counts in |tx_bytes| and |rx_bytes| |
+ // respectively and returns true if both values are available from |
+ // TrafficStats, otherwise returns false. |
bengr
2015/11/11 15:41:38
Say that tx_bytes and rx_bytes must not be null.
sclittle
2015/11/11 20:02:20
Done.
|
+ // Virtual for testing. |
+ virtual bool QueryTrafficStats(int64_t* tx_bytes, int64_t* rx_bytes) const; |
+ |
+ private: |
+ // Adds |tx_bytes| and |rx_bytes| as pre-amortization bytes, and schedules |
bengr
2015/11/11 15:41:38
What are "pre-amortization bytes?" Please spell ou
sclittle
2015/11/11 20:02:20
Done.
|
+ // amortization to happen later. |
+ void AddPreAmortizationBytes(int64_t tx_bytes, int64_t rx_bytes); |
+ |
+ // Amortizes any additional overhead from TrafficStats byte counts into the |
+ // |buffered_data_use_|, then passes the post-amortization DataUse objects to |
+ // their respective callbacks, flushing |buffered_data_use_|. |
+ void AmortizeNow(); |
+ |
+ base::ThreadChecker thread_checker_; |
+ |
+ // TickClock for determining the current time tick. |
+ scoped_ptr<base::TickClock> tick_clock_; |
+ |
+ // One-shot timer used to wait a short time after receiving DataUse before |
+ // querying TrafficStats, to give TrafficStats time to update and give the |
+ // network stack time to finish reporting multiple DataUse objects that happen |
+ // in rapid succession. This must not be a repeating timer. |
+ // |traffic_stats_query_timer_| is owned as a scoped_ptr so that fake timers |
+ // can be passed in for tests. |
+ scoped_ptr<base::Timer> traffic_stats_query_timer_; |
+ |
+ // The delay between data usage being reported to the amortizer before |
+ // querying TrafficStats. Used with |traffic_stats_query_timer_|. |
+ const base::TimeDelta traffic_stats_query_delay_; |
+ |
+ // The maximum amount of time that the TrafficStatsAmortizer is allowed to |
+ // spend waiting to perform amortization. Used with |
+ // |traffic_stats_query_timer_|. |
+ const base::TimeDelta max_amortization_delay_; |
+ |
+ // The maximum allowed size of the |buffered_data_use_| buffer, to prevent the |
+ // buffer from hogging memory. |
+ const size_t max_data_use_buffer_size_; |
+ |
+ // Indicates whether or not the TrafficStatsAmortizer currently has |
+ // pre-amortization bytes waiting for amortization to be performed. |
+ bool is_amortization_in_progress_; |
+ |
+ // The time when the first pre-amortization bytes for the current amortization |
+ // run were given to this TrafficStatsAmortizer. |
+ base::TimeTicks current_amortization_run_start_time_; |
+ |
+ // Buffer of pre-amortization data use that has accumulated since the last |
+ // time amortization was performed, paired with the callbacks for each DataUse |
+ // object. Nothing but |buffered_data_use_| is allowed to hold linked_ptrs to |
bengr
2015/11/11 15:41:38
Nothing but ... is allowed to -> Only ... may
sclittle
2015/11/11 20:02:20
Done.
|
+ // the DataUse objects, so that these linked_ptrs can be released later. |
+ std::vector<std::pair<linked_ptr<DataUse>, AmortizationCompleteCallback>> |
+ buffered_data_use_; |
+ |
+ // Indicates if TrafficStats byte counts were available during the last time |
+ // amortization was performed. |
+ bool are_last_amortization_traffic_stats_available_; |
bengr
2015/11/11 15:41:38
Add blank line below.
sclittle
2015/11/11 20:02:20
Done.
|
+ // The total transmitted bytes according to TrafficStats during the last time |
+ // amortization was performed, if they were available. |
+ int64_t last_amortization_traffic_stats_tx_bytes_; |
bengr
2015/11/11 15:41:38
Add blank line below.
sclittle
2015/11/11 20:02:20
Done.
|
+ // The total received bytes according to TrafficStats during the last time |
+ // amortization was performed, if they were available. |
+ int64_t last_amortization_traffic_stats_rx_bytes_; |
+ |
+ // Total pre-amortization transmitted bytes since the last time amortization |
+ // was performed, including bytes from |buffered_data_use_| and any extra |
+ // bytes that were added. |
+ int64_t pre_amortization_tx_bytes_; |
+ |
+ // Total pre-amortization received bytes since the last time amortization was |
+ // performed, including bytes from |buffered_data_use_| and any extra bytes |
+ // that were added. |
+ int64_t pre_amortization_rx_bytes_; |
+ |
+ base::WeakPtrFactory<TrafficStatsAmortizer> weak_ptr_factory_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(TrafficStatsAmortizer); |
+}; |
+ |
+} // namespace android |
bengr
2015/11/11 15:41:38
Add blank line below.
sclittle
2015/11/11 20:02:20
Done.
|
+} // namespace data_usage |
+ |
+#endif // COMPONENTS_DATA_USAGE_ANDROID_TRAFFIC_STATS_AMORTIZER_H_ |