[CrOS Tether] Sort Tether network lists.

chromeos/components/tether/host_scan_device_prioritizer.h

 // Copyright 2017 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_COMPONENTS_TETHER_HOST_SCAN_DEVICE_PRIORITIZER_H_
 #define CHROMEOS_COMPONENTS_TETHER_HOST_SCAN_DEVICE_PRIORITIZER_H_
 
 #include "base/macros.h"
+#include "chromeos/network/network_state_handler.h"
 #include "components/cryptauth/remote_device.h"
 
 namespace chromeos {
 
+class NetworkStateHandler;
+
 namespace tether {
 
 class TetherHostResponseRecorder;
+class DeviceIdTetherNetworkGuidMap;
 
 // Prioritizes the order of devices when performing a host scan. To optimize for
 // the most common tethering operations, this class uses the following rules:
 //   * The device which has most recently sent a successful
 //     ConnectTetheringResponse is always at the front of the queue.
 //   * Devices which have most recently sent a successful
 //     TetherAvailabilityResponse are next in the order, as long as they do not
 //     violate the first rule.
 //   * All other devices are left in the order they are passed.
-class HostScanDevicePrioritizer {
+class HostScanDevicePrioritizer
+    : public NetworkStateHandler::TetherNetworkListSorter {
  public:
   HostScanDevicePrioritizer(
-      TetherHostResponseRecorder* tether_host_response_recorder);
+      NetworkStateHandler* network_state_handler,
+      TetherHostResponseRecorder* tether_host_response_recorder,
+      DeviceIdTetherNetworkGuidMap* device_id_tether_network_guid_map);
   virtual ~HostScanDevicePrioritizer();
 
   // Prioritizes |remote_devices| using the rules described above.
   virtual void SortByHostScanOrder(
       std::vector<cryptauth::RemoteDevice>* remote_devices) const;
 
+  // NetworkStateHandler::TetherNetworkListSorter:
+  void SortTetherNetworkList(
+      NetworkStateHandler::ManagedStateList* tether_networks) const override;
+
  private:
+  // Performs sorting for both SortByHostScanOrder() and
+  // SortTetherNetworkList().
+  template <typename T>
+  void SortNetworks(std::vector<T>* list_to_sort) const;
+
+  // GetDeviceId() and Move() are used internally by SortNetworks() to sort
+  // lists of both cryptauth::RemoteDevice and std::unique_ptr<ManagedState>.
+  std::string GetDeviceId(const cryptauth::RemoteDevice& remote_device) const;
+  std::string GetDeviceId(
+      const std::unique_ptr<ManagedState>& tether_network_state) const;
+  cryptauth::RemoteDevice Move(
+      const cryptauth::RemoteDevice& remote_device) const;
+  std::unique_ptr<ManagedState> Move(

[Ryan Hansberry, 2017/06/19 19:17:48]

Why ManagedState instead of NetworkState?

[Kyle Horimoto, 2017/06/20 23:44:54]

The vector stored in NetworkStateHandler is a ManagedStateList.

+      std::unique_ptr<ManagedState>& tether_network_state) const;
+
+  NetworkStateHandler* network_state_handler_;
   TetherHostResponseRecorder* tether_host_response_recorder_;
+  DeviceIdTetherNetworkGuidMap* device_id_tether_network_guid_map_;
 
   DISALLOW_COPY_AND_ASSIGN(HostScanDevicePrioritizer);
 };
 
 }  // namespace tether
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_COMPONENTS_TETHER_HOST_SCAN_DEVICE_PRIORITIZER_H_