[CrOS Tether] Add the notion of a tether DeviceState.

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 94 matching lines @@
   }
 
   // Asynchronously sets the technology enabled property for |type|. Only
   // NetworkTypePattern::Primitive, ::Mobile and ::Ethernet are supported.
   // Note: Modifies Manager state. Calls |error_callback| on failure.
   void SetTechnologyEnabled(
       const NetworkTypePattern& type,
       bool enabled,
       const network_handler::ErrorCallback& error_callback);
 
+  // Sets the tether technology state. Because tether networks do not represent

[Ryan Hansberry, 2017/04/20 01:38:35]

Please refer to as "Tether" throughout documentation for consistency.

[Kyle Horimoto, 2017/04/20 02:16:08]

Done.

+  // real Shill networks, this value must be set by the tether component rather
+  // than being generated by Shill. See TetherDeviceStateManager for more
+  // details.
+  void SetTetherTechnologyState(TechnologyState technology_state);
+
+  // Sets the scanning state of the tether technology. Since tether network
+  // scans are not actually performed as part of Shill, this value must be set
+  // by the tether component.
+  void SetTetherScanState(bool is_scanning);
+
   // Asynchronously sets the list of prohibited technologies. The accepted
   // values are the shill network technology identifiers. See also
   // chromeos::onc::Validator::ValidateGlobalNetworkConfiguration().
   void SetProhibitedTechnologies(
       const std::vector<std::string>& prohibited_technologies,
       const network_handler::ErrorCallback& error_callback);
 
   // Finds and returns a device state by |device_path| or NULL if not found.
   const DeviceState* GetDeviceState(const std::string& device_path) const;
 
@@ skipping 118 matching lines @@
   // 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;
 
   // Requests a network scan. This may trigger updates to the network
-  // list, which will trigger the appropriate observer calls.
+  // list, which will trigger the appropriate observer calls. Note that this
+  // function does not request a tether scan.
+  // TODO(khorimoto): Add an also_scan_for_tether parameter. Tether scans should
+  // not occur during start-up, but they should occur when opening networking
+  // UI.
   void RequestScan() const;
 
   // Requests an update for an existing NetworkState, e.g. after configuring
   // a network. This is a no-op if an update request is already pending. To
   // ensure that a change is picked up, this must be called after Shill
   // acknowledged it (e.g. in the callback of a SetProperties).
   // When the properties are received, NetworkPropertiesUpdated will be
   // signaled for each member of |observers_|, regardless of whether any
-  // properties actually changed.
+  // properties actually changed. Note that this is a no-op for tether networks.
+  // TODO(khorimoto): Add network update functionality for tether networks.

[Ryan Hansberry, 2017/04/20 01:38:35]

Why will we need this for Tether?

[Kyle Horimoto, 2017/04/20 02:16:08]

We don't actually - you're right.

   void RequestUpdateForNetwork(const std::string& service_path);
 
   // Informs NetworkStateHandler to notify observers that the properties for
   // the network may have changed. Called e.g. when the proxy properties may
   // have changed.
   void SendUpdateNotificationForNetwork(const std::string& service_path);
 
   // Clears the last_error value for the NetworkState for |service_path|.
   void ClearLastErrorForNetwork(const std::string& service_path);
 
@@ skipping 202 matching lines @@
   // Keeps track of the default network for notifying observers when it changes.
   std::string default_network_path_;
 
   // List of interfaces on which portal check is enabled.
   std::string check_portal_list_;
 
   // 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. Initialized to
+  // PROHIBITED; this value is changed by the tether component when it starts
+  // up.
+  TechnologyState tether_state_ = TechnologyState::TECHNOLOGY_PROHIBITED;

[Ryan Hansberry, 2017/04/20 01:38:35]

nit: tether_technology_state_

[Ryan Hansberry, 2017/04/20 01:38:35]

I think a better default may be unavailable.

[Kyle Horimoto, 2017/04/20 02:16:08]

Done.

[Kyle Horimoto, 2017/04/20 02:16:08]

No, PROHIBITED makes more sense. This should only be changed if the the tether
Initializer starts up. If the policy disallows it from starting up, then it
should be PROHIBITED.

+
   // 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_