Submit buffered data use reports when Chromium is backgrounded

chrome/browser/android/data_usage/external_data_use_observer.h

 // 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 CHROME_BROWSER_ANDROID_DATA_USAGE_EXTERNAL_DATA_USE_OBSERVER_H_
 #define CHROME_BROWSER_ANDROID_DATA_USAGE_EXTERNAL_DATA_USE_OBSERVER_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <string>
 #include <vector>
 
 #include "base/containers/hash_tables.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.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_aggregator.h"
 #include "net/base/network_change_notifier.h"
 
+#if defined(OS_ANDROID)
+#include "base/android/application_status_listener.h"
+#endif
+
 namespace base {
 class SingleThreadTaskRunner;
 }
 
 namespace data_usage {
 struct DataUse;
 }
 
 namespace chrome {
 
@@ skipping 48 matching lines @@
   void ShouldRegisterAsDataUseObserver(bool should_register);
 
   base::WeakPtr<ExternalDataUseObserver> GetWeakPtr();
 
  private:
   friend class DataUseTabModelTest;
   friend class ExternalDataUseObserverTest;
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, BufferDataUseReports);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, BufferSize);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, DataUseReportTimedOut);
+#if defined(OS_ANDROID)
+  FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest,
+                           DataUseReportingOnApplicationStatusChange);
+#endif
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, HashFunction);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, MultipleMatchingRules);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest,
                            PeriodicFetchMatchingRules);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest,
                            RegisteredAsDataUseObserver);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest, ReportsMergedCorrectly);
   FRIEND_TEST_ALL_PREFIXES(DataUseUITabModelTest, ReportTabEventsTest);
   FRIEND_TEST_ALL_PREFIXES(ExternalDataUseObserverTest,
                            TimestampsMergedCorrectly);
@@ skipping 81 matching lines @@
   // network.
   void BufferDataUseReport(const data_usage::DataUse& data_use,
                            const std::string& label,
                            const base::Time& start_time,
                            const base::Time& end_time);
 
   // Submits the first data report among the buffered data reports in
   // |buffered_data_reports_|. Since an unordered map is used to buffer the
   // reports, the order of reports may change. The reports are buffered in an
   // arbitrary order and there are no guarantees that the next report to be
-  // submitted is the oldest one buffered.
-  void SubmitBufferedDataUseReport();
+  // submitted is the oldest one buffered. |immediate| indicates whether to
+  // submit the report immediately or to wait until |data_use_report_min_bytes_|
+  // unreported bytes are buffered.
+  void SubmitBufferedDataUseReport(bool immediate);
+
+#if defined(OS_ANDROID)
+  // Called whenever the application transitions from foreground to background
+  // or vice versa.
+  void OnApplicationStateChange(base::android::ApplicationState new_state);
+#endif
 
   // Aggregator that sends data use observations to |this|.
   data_usage::DataUseAggregator* data_use_aggregator_;
 
   // Maintains tab sessions and is owned by |this|. It is created on IO thread
   // but afterwards, should only be accessed on UI thread.
   DataUseTabModel* data_use_tab_model_;
 
   // Time when the currently pending data use report was submitted.
   // |last_data_report_submitted_ticks_| is null if no data use report is
@@ skipping 30 matching lines @@
   const base::TimeDelta fetch_matching_rules_duration_;
 
   // Minimum number of bytes that should be buffered before a data use report is
   // submitted.
   const int64_t data_use_report_min_bytes_;
 
   // If a data use report is pending for more than |data_report_submit_timeout_|
   // duration, it is considered as timed out.
   const base::TimeDelta data_report_submit_timeout_;
 
+#if defined(OS_ANDROID)
+  // Listens to when Chromium gets backgrounded and submits buffered data use
+  // reports.
+  scoped_ptr<base::android::ApplicationStatusListener> app_state_listener_;
+#endif
+
   // True if |this| is currently registered as a data use observer.
   bool registered_as_data_use_observer_;
 
   base::ThreadChecker thread_checker_;
 
   base::WeakPtrFactory<ExternalDataUseObserver> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ExternalDataUseObserver);
 };
 
 }  // namespace android
 
 }  // namespace chrome
 
 #endif  // CHROME_BROWSER_ANDROID_DATA_USAGE_EXTERNAL_DATA_USE_OBSERVER_H_