[CrOS Tether] Sort Tether network lists.

chromeos/network/network_state_handler.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 CHROMEOS_NETWORK_NETWORK_STATE_HANDLER_H_
 #define CHROMEOS_NETWORK_NETWORK_STATE_HANDLER_H_
 
 #include <map>
 #include <memory>
 #include <set>
@@ skipping 51 matching lines @@
 //   the initial properties are received. The GUID will be consistent for
 //   the duration of a session, even if the network drops out and returns.
 
 class CHROMEOS_EXPORT NetworkStateHandler
     : public internal::ShillPropertyHandler::Listener {
  public:
   typedef std::vector<std::unique_ptr<ManagedState>> ManagedStateList;
   typedef std::vector<const NetworkState*> NetworkStateList;
   typedef std::vector<const DeviceState*> DeviceStateList;
 
+  // Sorts Tether networks. Because sorting rules are determined by the Tether
+  // component, a delegate is required to sort the list.

[stevenjb, 2017/06/22 00:25:20]

This isn't really necessary/helpful, the name is clear and the method comment is
sufficient.

[Kyle Horimoto, 2017/06/22 02:08:01]

Done.

+  class TetherSortDelegate {
+   public:
+    // Sorts the list so that the highest-priority networks are in the front of
+    // the list.

[stevenjb, 2017/06/22 00:25:20]

This should be more generic::

// Sorts |tether_networks| according to the Tether component rules.
// |tether_networks| contains only networks of type Tether.

[Kyle Horimoto, 2017/06/22 02:08:01]

Done.

+    virtual void SortTetherNetworkList(
+        ManagedStateList* tether_networks) const = 0;
+  };
+
   enum TechnologyState {
     TECHNOLOGY_UNAVAILABLE,
     TECHNOLOGY_AVAILABLE,
     TECHNOLOGY_UNINITIALIZED,
     TECHNOLOGY_ENABLING,
     TECHNOLOGY_ENABLED,
     TECHNOLOGY_PROHIBITED
   };
 
   ~NetworkStateHandler() override;
@@ skipping 178 matching lines @@
   void SetTetherNetworkStateDisconnected(const std::string& guid);
 
   // Set the connection_state of the Tether NetworkState corresponding to the
   // provided |guid| to "Connecting". This will be reflected in the UI.
   void SetTetherNetworkStateConnecting(const std::string& guid);
 
   // Set the connection_state of the Tether NetworkState corresponding to the
   // provided |guid| to "Connected". This will be reflected in the UI.
   void SetTetherNetworkStateConnected(const std::string& guid);
 
+  // Sets the sorting delegate for Tether networks.

[stevenjb, 2017/06/22 00:25:20]

No need for a comment for a trivial setter.

[Kyle Horimoto, 2017/06/22 02:08:01]

Done.

+  void set_tether_sort_delegate(
+      const TetherSortDelegate* tether_sort_delegate) {
+    tether_sort_delegate_ = tether_sort_delegate;
+  }
+
   // Sets |list| to contain the list of devices.  The returned list contains
   // a copy of DeviceState pointers which should not be stored or used beyond
   // the scope of the calling function (i.e. they may later become invalid, but
   // only on the UI thread).
   void GetDeviceList(DeviceStateList* list) const;
 
   // Like GetDeviceList() but only returns networks with matching |type|.
   void GetDeviceListByType(const NetworkTypePattern& type,
                            DeviceStateList* list) const;
 
@@ skipping 236 matching lines @@
 
   // Map of network specifiers to guids. Contains an entry for each
   // NetworkState that is not saved in a profile.
   SpecifierGuidMap specifier_guid_map_;
 
   // The state corresponding to the Tether device type. This value is managed by
   // the Tether component.
   TechnologyState tether_technology_state_ =
       TechnologyState::TECHNOLOGY_UNAVAILABLE;
 
+  // Not owned by this instance.
+  const TetherSortDelegate* tether_sort_delegate_ = nullptr;
+
   // Ensure that Shutdown() gets called exactly once.
   bool did_shutdown_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(NetworkStateHandler);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_NETWORK_NETWORK_STATE_HANDLER_H_