Make NQE a derived class of NetworkQualityProvider

net/nqe/network_quality_estimator.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 NET_NQE_NETWORK_QUALITY_ESTIMATOR_H_
 #define NET_NQE_NETWORK_QUALITY_ESTIMATOR_H_
 
 #include <stdint.h>
 
 #include <map>
 #include <memory>
 #include <string>
 
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/optional.h"
 #include "base/threading/thread_checker.h"
 #include "base/time/time.h"
 #include "net/base/net_export.h"
 #include "net/base/network_change_notifier.h"
 #include "net/nqe/cached_network_quality.h"
 #include "net/nqe/effective_connection_type.h"
+#include "net/nqe/effective_connection_type_observer.h"
 #include "net/nqe/event_creator.h"
 #include "net/nqe/external_estimate_provider.h"
 #include "net/nqe/network_id.h"
 #include "net/nqe/network_quality.h"
 #include "net/nqe/network_quality_estimator_params.h"
 #include "net/nqe/network_quality_observation.h"
 #include "net/nqe/network_quality_observation_source.h"
+#include "net/nqe/network_quality_provider.h"
 #include "net/nqe/network_quality_store.h"
 #include "net/nqe/observation_buffer.h"
+#include "net/nqe/rtt_throughput_estimates_observer.h"
 #include "net/socket/socket_performance_watcher_factory.h"
 
 namespace base {
 class TickClock;
 }  // namespace base
 
 namespace net {
 
 class NetLog;
 
 namespace nqe {
 namespace internal {
 class ThroughputAnalyzer;
 }
 }
 
 class URLRequest;
 
 // NetworkQualityEstimator provides network quality estimates (quality of the
 // full paths to all origins that have been connected to).
 // The estimates are based on the observed organic traffic.
 // A NetworkQualityEstimator instance is attached to URLRequestContexts and
 // observes the traffic of URLRequests spawned from the URLRequestContexts.
 // A single instance of NQE can be attached to multiple URLRequestContexts,
 // thereby increasing the single NQE instance's accuracy by providing more
 // observed traffic characteristics.
 class NET_EXPORT NetworkQualityEstimator
     : public NetworkChangeNotifier::ConnectionTypeObserver,
-      public ExternalEstimateProvider::UpdatedEstimateDelegate {
+      public ExternalEstimateProvider::UpdatedEstimateDelegate,
+      public NetworkQualityProvider {
  public:
-  // Observes changes in effective connection type.
-  class NET_EXPORT EffectiveConnectionTypeObserver {
-   public:
-    // Notifies the observer of a change in the effective connection type.
-    // NetworkQualityEstimator computes the effective connection type once in
-    // every interval of duration
-    // |effective_connection_type_recomputation_interval_|. Additionally, when
-    // there is a change in the connection type of the device, then the
-    // effective connection type is immediately recomputed. The observer must
-    // register and unregister itself on the IO thread. All the observers would
-    // be notified on the IO thread.
-    //
-    // If the computed effective connection type is different from the
-    // previously notified effective connection type, then all the registered
-    // observers are notified of the new effective connection type.
-    virtual void OnEffectiveConnectionTypeChanged(
-        EffectiveConnectionType type) = 0;
-
-   protected:
-    EffectiveConnectionTypeObserver() {}
-    virtual ~EffectiveConnectionTypeObserver() {}
-
-   private:
-    DISALLOW_COPY_AND_ASSIGN(EffectiveConnectionTypeObserver);
-  };
-
-  // Observes changes in the network quality.
-  class NET_EXPORT RTTAndThroughputEstimatesObserver {
-   public:
-    // Notifies the observer when estimated HTTP RTT, estimated transport RTT or
-    // estimated downstream throughput is computed. NetworkQualityEstimator
-    // computes the RTT and throughput estimates at regular intervals.
-    // Additionally, when there is a change in the connection type of the
-    // device, then the estimates are immediately computed. The observer must
-    // register and unregister itself on the IO thread. All the observers would
-    // be notified on the IO thread.
-    //
-    // |http_rtt|, |transport_rtt| and |downstream_throughput_kbps| are the
-    // computed estimates of the HTTP RTT, transport RTT and downstream
-    // throughput (in kilobits per second), respectively. If an estimate of the
-    // HTTP or transport RTT is unavailable, it will be set to
-    // nqe::internal::InvalidRTT(). If the throughput estimate is unavailable,
-    // it will be set to nqe::internal::kInvalidThroughput.
-    virtual void OnRTTOrThroughputEstimatesComputed(
-        base::TimeDelta http_rtt,
-        base::TimeDelta transport_rtt,
-        int32_t downstream_throughput_kbps) = 0;
-
-    virtual ~RTTAndThroughputEstimatesObserver() {}
-
-   protected:
-    RTTAndThroughputEstimatesObserver() {}
-
-   private:
-    DISALLOW_COPY_AND_ASSIGN(RTTAndThroughputEstimatesObserver);
-  };
-
   // Observes measurements of round trip time.
   class NET_EXPORT_PRIVATE RTTObserver {
    public:
     // Will be called when a new RTT observation is available. The round trip
     // time is specified in milliseconds. The time when the observation was
     // taken and the source of the observation are provided.
     virtual void OnRTTObservation(int32_t rtt_ms,
                                   const base::TimeTicks& timestamp,
                                   NetworkQualityObservationSource source) = 0;
 
@@ skipping 16 matching lines @@
         NetworkQualityObservationSource source) = 0;
 
    protected:
     ThroughputObserver() {}
     virtual ~ThroughputObserver() {}
 
    private:
     DISALLOW_COPY_AND_ASSIGN(ThroughputObserver);
   };
 
-  // Provides simple interface to obtain the effective connection type.
-  class NET_EXPORT NetworkQualityProvider {
-   public:
-    virtual ~NetworkQualityProvider() {}
-
-    // Returns the current effective connection type.
-    virtual EffectiveConnectionType GetEffectiveConnectionType() const = 0;
-
-    // Adds |observer| to a list of effective connection type observers.
-    virtual void AddEffectiveConnectionTypeObserver(
-        EffectiveConnectionTypeObserver* observer) = 0;
-
-    // Removes |observer| from a list of effective connection type observers.
-    virtual void RemoveEffectiveConnectionTypeObserver(
-        EffectiveConnectionTypeObserver* observer) = 0;
-
-    // Returns the current HTTP RTT estimate. If the estimate is unavailable,
-    // the returned optional value is null.
-    virtual base::Optional<base::TimeDelta> GetHttpRTT() const;
-
-    // Returns the current transport RTT estimate. If the estimate is
-    // unavailable, the returned optional value is null.
-    virtual base::Optional<base::TimeDelta> GetTransportRTT() const;
-
-    // Returns the current downstream throughput estimate (in kilobits per
-    // second). If the estimate is unavailable, the returned optional value is
-    // null.
-    virtual base::Optional<int32_t> GetDownstreamThroughputKbps() const;
-
-    // Adds |observer| to the list of RTT and throughput estimate observers.
-    // |observer| would be notified of the current RTT and throughput estimates
-    // in the next message pump.
-    virtual void AddRTTAndThroughputEstimatesObserver(
-        RTTAndThroughputEstimatesObserver* observer) = 0;
-
-    // Removes |observer| from the list of RTT and throughput estimate
-    // observers.
-    virtual void RemoveRTTAndThroughputEstimatesObserver(
-        RTTAndThroughputEstimatesObserver* observer) = 0;
-
-   protected:
-    NetworkQualityProvider() {}
-
-   private:
-    DISALLOW_COPY_AND_ASSIGN(NetworkQualityProvider);
-  };
-
   // Creates a new NetworkQualityEstimator.
   // |variation_params| is the map containing all field trial parameters
   // related to NetworkQualityEstimator field trial.
   // |external_estimates_provider| may be NULL. The caller must guarantee that
   // |net_log| outlives |this|.
   NetworkQualityEstimator(
       std::unique_ptr<ExternalEstimateProvider> external_estimates_provider,
       const std::map<std::string, std::string>& variation_params,
       NetLog* net_log);
 
@@ skipping 12 matching lines @@
   // outlives |this|.
   NetworkQualityEstimator(
       std::unique_ptr<ExternalEstimateProvider> external_estimates_provider,
       const std::map<std::string, std::string>& variation_params,
       bool use_local_host_requests_for_tests,
       bool use_smaller_responses_for_tests,
       NetLog* net_log);
 
   ~NetworkQualityEstimator() override;
 
-  // Returns the last computed effective type of the current connection. The
-  // effective connection type is computed by the network quality estimator at
-  // regular intervals and at certain events (e.g., connection change).
-  // Virtualized for testing.
-  virtual EffectiveConnectionType GetEffectiveConnectionType() const;
-
   // Returns the effective type of the current connection based on only the
   // samples observed after |start_time|. This should only be used for
   // recording the metrics. Virtualized for testing.
   virtual EffectiveConnectionType GetRecentEffectiveConnectionType(
       const base::TimeTicks& start_time) const;
 
-  // Adds |observer| to the list of effective connection type observers. Must be
-  // called on the IO thread. |observer| would be notified of the current
-  // effective connection type in the next message pump.
+  // NetworkQualityProvider implementation:
+  // Must be called on the IO thread.
+  EffectiveConnectionType GetEffectiveConnectionType() const override;
   void AddEffectiveConnectionTypeObserver(
-      EffectiveConnectionTypeObserver* observer);
-
-  // Removes |observer| from the list of effective connection type observers.
-  // Must be called on the IO thread.
+      EffectiveConnectionTypeObserver* observer) override;
   void RemoveEffectiveConnectionTypeObserver(
-      EffectiveConnectionTypeObserver* observer);
-
-  // Adds |observer| to the list of RTT and throughput estimate observers. Must
-  // be called on the IO thread. |observer| would be notified of the current RTT
-  // and throughput estimates in the next message pump.
+      EffectiveConnectionTypeObserver* observer) override;
+  base::Optional<base::TimeDelta> GetHttpRTT() const override;
+  base::Optional<base::TimeDelta> GetTransportRTT() const override;
+  base::Optional<int32_t> GetDownstreamThroughputKbps() const override;
   void AddRTTAndThroughputEstimatesObserver(
-      RTTAndThroughputEstimatesObserver* observer);
-
-  // Removes |observer| from the list of RTT and throughput estimate observers.
-  // Must be called on the IO thread.
+      RTTAndThroughputEstimatesObserver* observer) override;
   void RemoveRTTAndThroughputEstimatesObserver(
-      RTTAndThroughputEstimatesObserver* observer);
+      RTTAndThroughputEstimatesObserver* observer) override;
 
   // Notifies NetworkQualityEstimator that the response header of |request| has
   // been received.
   void NotifyHeadersReceived(const URLRequest& request);
 
   // Notifies NetworkQualityEstimator that the headers of |request| are about to
   // be sent.
   void NotifyStartTransaction(const URLRequest& request);
 
   // Notifies NetworkQualityEstimator that the response body of |request| has
@@ skipping 53 matching lines @@
   void RemoveNetworkQualitiesCacheObserver(
       nqe::internal::NetworkQualityStore::NetworkQualitiesCacheObserver*
           observer);
 
   // Called when the persistent prefs have been read. |read_prefs| contains the
   // parsed prefs as a map between NetworkIDs and CachedNetworkQualities.
   void OnPrefsRead(
       const std::map<nqe::internal::NetworkID,
                      nqe::internal::CachedNetworkQuality> read_prefs);
 
-  // Returns the current transport RTT estimate. If the estimate is unavailable,
-  // the returned optional has no value.
-  base::Optional<base::TimeDelta> GetTransportRTT() const;
-
  protected:
   // A protected constructor for testing that allows setting the value of
   // |add_default_platform_observations_|.
   NetworkQualityEstimator(
       std::unique_ptr<ExternalEstimateProvider> external_estimates_provider,
       const std::map<std::string, std::string>& variation_params,
       bool use_local_host_requests_for_tests,
       bool use_smaller_responses_for_tests,
       bool add_default_platform_observations,
       const NetLogWithSource& net_log);
@@ skipping 435 matching lines @@
       disallowed_observation_sources_for_transport_;
 
   base::WeakPtrFactory<NetworkQualityEstimator> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(NetworkQualityEstimator);
 };
 
 }  // namespace net
 
 #endif  // NET_NQE_NETWORK_QUALITY_ESTIMATOR_H_