Add connection type to NCN::MaxBandwidthChanged

net/base/network_change_notifier.h

 // Copyright (c) 2012 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_BASE_NETWORK_CHANGE_NOTIFIER_H_
 #define NET_BASE_NETWORK_CHANGE_NOTIFIER_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
@@ skipping 168 matching lines @@
    protected:
     NetworkChangeObserver() {}
     virtual ~NetworkChangeObserver() {}
 
    private:
     DISALLOW_COPY_AND_ASSIGN(NetworkChangeObserver);
   };
 
   class NET_EXPORT MaxBandwidthObserver {
    public:
-    // Will be called when a change occurs to the network's maximum bandwidth as
-    // defined in http://w3c.github.io/netinfo/. Generally this will only be
-    // called on bandwidth changing network connection/disconnection events.
-    // Some platforms may call it more frequently, such as when WiFi signal
-    // strength changes.
-    // TODO(jkarlin): This is currently only implemented for Android. Implement
-    // on every platform.
-    virtual void OnMaxBandwidthChanged(double max_bandwidth_mbps) = 0;
+    // Called when a change occurs to the network's maximum bandwidth as
+    // defined in http://w3c.github.io/netinfo/. Also called on type change,
+    // even if the maximum bandwidth doesn't change. See the documentation of
+    // GetMaxBanwidth for what to expect for the values of |max_bandwidth_mbps|.

[pauljensen, 2015/09/15 18:17:40]

GetMaxBandwidth->GetMaxBandwidthAndConnectionType

[jkarlin, 2015/09/16 12:12:22]

Done.

+    virtual void OnMaxBandwidthChanged(ConnectionType type,
+                                       double max_bandwidth_mbps) = 0;
 
    protected:
     MaxBandwidthObserver() {}
     virtual ~MaxBandwidthObserver() {}
 
    private:
     DISALLOW_COPY_AND_ASSIGN(MaxBandwidthObserver);
   };
 
   virtual ~NetworkChangeNotifier();
@@ skipping 20 matching lines @@
   // user won't be able to connect to remote sites. However, another return
   // value doesn't imply that the user will be able to connect to remote sites;
   // even if some link is up, it is uncertain whether a particular connection
   // attempt to a particular remote site will be successful.
   // The returned value only describes the connection currently used by the
   // device, and does not take into account other machines on the network. For
   // example, if the device is connected using Wifi to a 3G gateway to access
   // the internet, the connection type is CONNECTION_WIFI.
   static ConnectionType GetConnectionType();
 
-  // Returns a theoretical upper limit on download bandwidth, potentially based
-  // on underlying connection type, signal strength, or some other signal. The
-  // default mapping of connection type to maximum bandwidth is provided in the
-  // NetInfo spec: http://w3c.github.io/netinfo/. Host-specific application
-  // permissions may be required, please see host-specific declaration for more
-  // information.
-  static double GetMaxBandwidth();
+  // Sets |max_bandwidth_mbps| to a theoretical upper limit on download
+  // bandwidth, potentially based on underlying connection type, signal
+  // strength, or some other signal. Specifically, it returns +Infinity if there
+  // is a connection and 0.0 otherwise. The circumstances in which a more

[pauljensen, 2015/09/15 18:17:40]

Um I think it does more than "Specifically, it returns +Infinity if there is a
connection and 0.0 otherwise."

[jkarlin, 2015/09/16 12:12:22]

Done.

+  // specific value is given are:  Android cellular types, Android wifi types,

[pauljensen, 2015/09/15 18:17:40]

can we reword the "types" here to something like "when an Android device is
connected to a cellular or WiFi network"

[pauljensen, 2015/09/15 18:17:40]

wifi->WiFi

[jkarlin, 2015/09/16 12:12:22]

Done.

[jkarlin, 2015/09/16 12:12:22]

Done.

+  // and ChromeOS cellular types. See the NetInfo spec for the mapping of
+  // specific subtypes to bandwidth values: http://w3c.github.io/netinfo/.
+  // |connection_type| is set to the current ConnectionType.

[pauljensen, 2015/09/15 18:17:40]

ConnectionType->active default network's connection type

[jkarlin, 2015/09/16 12:12:22]

Done.

+  static void GetMaxBandwidthAndConnectionType(double* max_bandwidth_mbps,
+                                               ConnectionType* connection_type);
 
   // Retrieve the last read DnsConfig. This could be expensive if the system has
   // a large HOSTS file.
   static void GetDnsConfig(DnsConfig* config);
 
 #if defined(OS_LINUX)
   // Returns the AddressTrackerLinux if present.
   static const internal::AddressTrackerLinux* GetAddressTracker();
 #endif
 
@@ skipping 48 matching lines @@
   static void RemoveDNSObserver(DNSObserver* observer);
   static void RemoveNetworkChangeObserver(NetworkChangeObserver* observer);
   static void RemoveMaxBandwidthObserver(MaxBandwidthObserver* observer);
 
   // Allow unit tests to trigger notifications.
   static void NotifyObserversOfIPAddressChangeForTests();
   static void NotifyObserversOfConnectionTypeChangeForTests(
       ConnectionType type);
   static void NotifyObserversOfNetworkChangeForTests(ConnectionType type);
   static void NotifyObserversOfInitialDNSConfigReadForTests();
+  static void NotifyObserversOfMaxBandwidthChangeForTests(ConnectionType type,
+                                                          double max_bandwidth);
 
   // Enable or disable notifications from the host. After setting to true, be
   // sure to pump the RunLoop until idle to finish any preexisting
   // notifications. To use this, it must must be called before a
   // NetworkChangeNotifier is created.
   static void SetTestNotificationsOnly(bool test_only);
 
   // Return a string equivalent to |type|.
   static const char* ConnectionTypeToString(ConnectionType type);
 
@@ skipping 63 matching lines @@
 #if defined(OS_LINUX)
   // Returns the AddressTrackerLinux if present.
   // TODO(szym): Retrieve AddressMap from NetworkState. http://crbug.com/144212
   virtual const internal::AddressTrackerLinux*
       GetAddressTrackerInternal() const;
 #endif
 
   // See the description of NetworkChangeNotifier::GetMaxBandwidth().
   // Implementations must be thread-safe. Implementations must also be
   // cheap as it is called often.
-  virtual double GetCurrentMaxBandwidth() const;
+  virtual void GetCurrentMaxBandwidthAndConnectionType(
+      double* max_bandwidth_mbps,
+      ConnectionType* connection_type) const;
 
   // Returns a theoretical upper limit on download bandwidth given a connection
   // subtype. The mapping of connection type to maximum bandwidth is provided in
   // the NetInfo spec: http://w3c.github.io/netinfo/.
   static double GetMaxBandwidthForConnectionSubtype(ConnectionSubtype subtype);
 
   // Broadcasts a notification to all registered observers.  Note that this
   // happens asynchronously, even for observers on the current thread, even in
   // tests.
   static void NotifyObserversOfIPAddressChange();
   static void NotifyObserversOfConnectionTypeChange();
   static void NotifyObserversOfDNSChange();
   static void NotifyObserversOfInitialDNSConfigRead();
   static void NotifyObserversOfNetworkChange(ConnectionType type);
-  static void NotifyObserversOfMaxBandwidthChange(double max_bandwidth_mbps);
+  static void NotifyObserversOfMaxBandwidthChange(ConnectionType type,
+                                                  double max_bandwidth_mbps);
 
   // Stores |config| in NetworkState and notifies OnDNSChanged observers.
   static void SetDnsConfig(const DnsConfig& config);
   // Stores |config| in NetworkState and notifies OnInitialDNSConfigRead
   // observers.
   static void SetInitialDnsConfig(const DnsConfig& config);
 
  private:
   friend class HostResolverImplDnsTest;
   friend class NetworkChangeNotifierAndroidTest;
   friend class NetworkChangeNotifierLinuxTest;
   friend class NetworkChangeNotifierWinTest;
 
   class NetworkState;
   class NetworkChangeCalculator;
 
   void NotifyObserversOfIPAddressChangeImpl();
   void NotifyObserversOfConnectionTypeChangeImpl(ConnectionType type);
   void NotifyObserversOfDNSChangeImpl();
   void NotifyObserversOfInitialDNSConfigReadImpl();
   void NotifyObserversOfNetworkChangeImpl(ConnectionType type);
-  void NotifyObserversOfMaxBandwidthChangeImpl(double max_bandwidth_mbps);
+  void NotifyObserversOfMaxBandwidthChangeImpl(ConnectionType type,
+                                               double max_bandwidth_mbps);
 
   const scoped_refptr<base::ObserverListThreadSafe<IPAddressObserver>>
       ip_address_observer_list_;
   const scoped_refptr<base::ObserverListThreadSafe<ConnectionTypeObserver>>
       connection_type_observer_list_;
   const scoped_refptr<base::ObserverListThreadSafe<DNSObserver>>
       resolver_state_observer_list_;
   const scoped_refptr<base::ObserverListThreadSafe<NetworkChangeObserver>>
       network_change_observer_list_;
   const scoped_refptr<base::ObserverListThreadSafe<MaxBandwidthObserver>>
@@ skipping 10 matching lines @@
 
   // Set true to disable non-test notifications (to prevent flakes in tests).
   static bool test_notifications_only_;
 
   DISALLOW_COPY_AND_ASSIGN(NetworkChangeNotifier);
 };
 
 }  // namespace net
 
 #endif  // NET_BASE_NETWORK_CHANGE_NOTIFIER_H_