Add function document, and small refactor around Start/StopArc().

chrome/browser/chromeos/arc/arc_session_manager.h

 // Copyright 2016 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 CHROME_BROWSER_CHROMEOS_ARC_ARC_SESSION_MANAGER_H_
 #define CHROME_BROWSER_CHROMEOS_ARC_ARC_SESSION_MANAGER_H_
 
 #include <memory>
 #include <ostream>
 #include <string>
@@ skipping 170 matching lines @@
   void OnIsSyncingChanged() override;
 
   // ArcSupportHost::Observer:
   void OnWindowClosed() override;
   void OnTermsAgreed(bool is_metrics_enabled,
                      bool is_backup_and_restore_enabled,
                      bool is_location_service_enabled) override;
   void OnRetryClicked() override;
   void OnSendFeedbackClicked() override;
 
-  // Stops ARC without changing ArcEnabled preference.
-  void StopArc();
-
   // StopArc(), then restart. Between them data clear may happens.
   // This is a special method to support enterprise device lost case.
   // This can be called only when ARC is running.
   void StopAndEnableArc();
 
   // Removes the data if ARC is stopped. Otherwise, queue to remove the data
   // on ARC is stopped. A log statement with the removal reason must be added
   // prior to calling RemoveArcData().
   void RemoveArcData();
 
   ArcSupportHost* support_host() { return support_host_.get(); }
 
   // TODO(hidehiko): Get rid of the getter by migration between ArcAuthContext
   // and ArcAuthInfoFetcher.
   ArcAuthContext* auth_context() { return context_.get(); }
 
-  void StartArc();
-
+  // On provisioning completion (regardless of whether successfully done or
+  // not), this is called with its status. On success, called with
+  // ProvisioningResult::SUCCESS, otherwise |result| is the error reason.
   void OnProvisioningFinished(ProvisioningResult result);
 
   // Returns the time when the sign in process started, or a null time if
   // signing in didn't happen during this session.
   base::Time sign_in_start_time() const { return sign_in_start_time_; }
 
   // Returns the time when ARC was about to start, or a null time if ARC has not
   // been started yet.
   base::Time arc_start_time() const { return arc_start_time_; }
 
   // Injectors for testing.
   void SetArcSessionRunnerForTesting(
       std::unique_ptr<ArcSessionRunner> arc_session_runner);
   void SetAttemptUserExitCallbackForTesting(const base::Closure& callback);
 
   // Returns whether the Play Store app is requested to be launched by this
   // class. Should be used only for tests.
   bool IsPlaystoreLaunchRequestedForTesting() const;
 
+  // Invoking StartArc() only for testing, e.g., to emulate accepting Terms of
+  // Service then passing Android management check successfully.
+  void StartArcForTesting() { StartArc(); }
+
  private:
   // RequestEnable() has a check in order not to trigger starting procedure
   // twice. This method can be called to bypass that check when restarting.
   void RequestEnableImpl();
 
   // Negotiates the terms of service to user.
   void StartTermsOfServiceNegotiation();
   void OnTermsOfServiceNegotiated(bool accepted);
 
   // Returns whether ARC is managed and all ARC related OptIn preferences are
@@ skipping 13 matching lines @@
   // Called when the Android management check is done in opt-in flow or
   // re-auth flow.
   void OnAndroidManagementChecked(
       policy::AndroidManagementClient::Result result);
 
   // Called when the background Android management check is done. It is
   // triggered when the second or later ARC boot timing.
   void OnBackgroundAndroidManagementChecked(
       policy::AndroidManagementClient::Result result);
 
+  // Requests to starts ARC instance. Also, update the internal state to
+  // ACTIVE.
+  void StartArc();
+
+  // Requests to stop ARC instnace. This resets two persistent flags:
+  // kArcSignedIn and kArcTermsAccepted, so that, in next enabling,
+  // it is started from Terms of Service negotiation.
+  // TODO(hidehiko): Introduce STOPPING state, and this function should
+  // transition to it.
+  void StopArc();
+
   // ArcSessionRunner::Observer:
   void OnSessionStopped(ArcStopReason reason, bool restarting) override;
 
   std::unique_ptr<ArcSessionRunner> arc_session_runner_;
 
   // Unowned pointer. Keeps current profile.
   Profile* profile_ = nullptr;
 
   // Registrar used to monitor ARC enabled state.
   PrefChangeRegistrar pref_change_registrar_;
@@ skipping 29 matching lines @@
   DISALLOW_COPY_AND_ASSIGN(ArcSessionManager);
 };
 
 // Outputs the stringified |state| to |os|. This is only for logging purposes.
 std::ostream& operator<<(std::ostream& os,
                          const ArcSessionManager::State& state);
 
 }  // namespace arc
 
 #endif  // CHROME_BROWSER_CHROMEOS_ARC_ARC_SESSION_MANAGER_H_