Add an observer interface for DriveScheduler.

chrome/browser/chromeos/drive/drive_scheduler.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 CHROME_BROWSER_CHROMEOS_DRIVE_DRIVE_SCHEDULER_H_
 #define CHROME_BROWSER_CHROMEOS_DRIVE_DRIVE_SCHEDULER_H_
 
 #include <list>
+#include <vector>
 
 #include "base/id_map.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/observer_list.h"
 #include "chrome/browser/chromeos/drive/drive_file_system_interface.h"
+#include "chrome/browser/chromeos/drive/job_list_interface.h"
 #include "chrome/browser/google_apis/drive_service_interface.h"
 #include "chrome/browser/google_apis/drive_uploader.h"
 #include "net/base/network_change_notifier.h"
 
 class Profile;
 
 namespace drive {
 
 // The DriveScheduler is responsible for queuing and scheduling drive
 // operations.  It is responsible for handling retry logic, rate limiting, as
 // concurrency as appropriate.
 //
 // TODO(zork): Provide an interface for querying the number of jobs, and state
 // of each.  See: crbug.com/154243

[satorux1, 2013/04/17 00:53:57]

remove the TODO, now you are adding such an interface?

[kinaba, 2013/04/17 01:03:54]

Done. Good catch.

 class DriveScheduler
-    : public net::NetworkChangeNotifier::ConnectionTypeObserver {
+    : public net::NetworkChangeNotifier::ConnectionTypeObserver,
+      public JobListInterface {
  public:
-  // Enum representing the type of job.
-  enum JobType {
-    TYPE_GET_ABOUT_RESOURCE,
-    TYPE_GET_ACCOUNT_METADATA,
-    TYPE_GET_APP_LIST,
-    TYPE_GET_ALL_RESOURCE_LIST,
-    TYPE_GET_RESOURCE_LIST_IN_DIRECTORY,
-    TYPE_SEARCH,
-    TYPE_GET_CHANGE_LIST,
-    TYPE_CONTINUE_GET_RESOURCE_LIST,
-    TYPE_GET_RESOURCE_ENTRY,
-    TYPE_DELETE_RESOURCE,
-    TYPE_COPY_HOSTED_DOCUMENT,
-    TYPE_RENAME_RESOURCE,
-    TYPE_ADD_RESOURCE_TO_DIRECTORY,
-    TYPE_REMOVE_RESOURCE_FROM_DIRECTORY,
-    TYPE_ADD_NEW_DIRECTORY,
-    TYPE_DOWNLOAD_FILE,
-    TYPE_UPLOAD_NEW_FILE,
-    TYPE_UPLOAD_EXISTING_FILE,
-  };
-
-  // Current state of the job.
-  enum JobState {
-    // The job is queued, but not yet executed.
-    STATE_NONE,
-
-    // The job is in the process of being handled.
-    STATE_RUNNING,
-
-    // The job failed, but has been re-added to the queue.
-    STATE_RETRY,
-  };
-
-  // Unique ID assigned to each job. It is base::IDMap<JobInfo>::KeyType.
-  typedef int32 JobID;
-
-  // Information about a specific job that is visible to other systems.
-  struct JobInfo {
-    explicit JobInfo(JobType in_job_type);
-
-    // Type of the job.
-    JobType job_type;
-
-    // Id of the job, which can be used to query or modify it.
-    JobID job_id;
-
-    // Number of bytes completed, if applicable.
-    int completed_bytes;
-
-    // Total bytes of this operation, if applicable.
-    int total_bytes;
-
-    // Drive path of the file that this job acts on.
-    base::FilePath file_path;
-
-    // Current state of the operation.
-    JobState state;
-  };
-
   DriveScheduler(Profile* profile,
                  google_apis::DriveServiceInterface* drive_service);
   virtual ~DriveScheduler();
 
   // Initializes the object. This function should be called before any
   // other functions.
   void Initialize();
 
+  // JobListInterface overrides.
+  virtual std::vector<JobInfo> GetJobInfoList() OVERRIDE;
+  virtual void AddObserver(JobListObserver* observer) OVERRIDE;
+  virtual void RemoveObserver(JobListObserver* observer) OVERRIDE;
+
   // Adds a GetAccountMetadata operation to the queue.
   // |callback| must not be null.
   void GetAccountMetadata(
       const google_apis::GetAccountMetadataCallback& callback);
 
   // Adds a GetAppList operation to the queue.
   // |callback| must not be null.
   void GetAppList(const google_apis::GetAppListCallback& callback);
 
   // Adds a GetAboutResource operation to the queue.
@@ skipping 313 matching lines @@
   // net::NetworkChangeNotifier::ConnectionTypeObserver override.
   virtual void OnConnectionTypeChanged(
       net::NetworkChangeNotifier::ConnectionType type) OVERRIDE;
 
   // Get the type of queue the specified job should be put in.
   QueueType GetJobQueueType(JobType type);
 
   // For testing only.  Disables throttling so that testing is faster.
   void SetDisableThrottling(bool disable) { disable_throttling_ = disable; }
 
+  // Notifies updates to observers.
+  void NotifyJobAdded(const JobInfo& job_id);
+  void NotifyJobDone(const JobInfo& job_id);
+  void NotifyJobUpdated(const JobInfo& job_id);
+
   // Number of jobs in flight for each queue.
   int jobs_running_[NUM_QUEUES];
 
-  // Next value that should be assigned as a job id.
-  int next_job_id_;
-
   // The number of times operations have failed in a row, capped at
   // kMaxThrottleCount.  This is used to calculate the delay before running the
   // next task.
   int throttle_count_;
 
   // Disables throttling for testing.
   bool disable_throttling_;
 
   // The queues of jobs.
   std::list<QueueEntry*> queue_[NUM_QUEUES];
 
   // The list of unfinished (= queued or running) job info indexed by job IDs.
   typedef IDMap<JobInfo, IDMapOwnPointer> JobIDMap;
   JobIDMap job_map_;
 
+  // The list of observers for the scheduler.
+  ObserverList<JobListObserver> observer_list_;
+
   google_apis::DriveServiceInterface* drive_service_;
   scoped_ptr<google_apis::DriveUploaderInterface> uploader_;
 
   Profile* profile_;
 
   // Whether this instance is initialized or not.
   bool initialized_;
 
   // Note: This should remain the last member so it'll be destroyed and
   // invalidate its weak pointers before any other members are destroyed.
   base::WeakPtrFactory<DriveScheduler> weak_ptr_factory_;
   DISALLOW_COPY_AND_ASSIGN(DriveScheduler);
 };
 
 }  // namespace drive
 
 #endif  // CHROME_BROWSER_CHROMEOS_DRIVE_DRIVE_SCHEDULER_H_