Synced Notification Sync Change Processor

chrome/browser/notifier/chrome_notifier_service.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_NOTIFIER_CHROME_NOTIFIER_SERVICE_H_
+#define CHROME_BROWSER_NOTIFIER_CHROME_NOTIFIER_SERVICE_H_
+
+#include "base/basictypes.h"
+#include "base/memory/scoped_vector.h"
+#include "base/threading/non_thread_safe.h"
+#include "chrome/browser/notifier/synced_notification.h"
+#include "chrome/browser/profiles/profile_keyed_service.h"
+#include "sync/api/syncable_service.h"
+
+class Profile;
+class NotificationUIManager;
+
+namespace notifier {
+
+// The ChromeNotifierService holds notifications which represent the state of
+// delivered notifications for chrome. These are obtained from the sync service
+// and kept up to date.
+class ChromeNotifierService : public syncer::SyncableService,
+                              public ProfileKeyedService {
+
+ public:
+  ChromeNotifierService(Profile* profile, NotificationUIManager* manager);
+  virtual ~ChromeNotifierService();
+
+  // Methods from ProfileKeyedService.
+  virtual void Shutdown() OVERRIDE;
+
+  // syncer::SyncableService implementation.
+  virtual syncer::SyncMergeResult MergeDataAndStartSyncing(
+      syncer::ModelType type,
+      const syncer::SyncDataList& initial_sync_data,
+      scoped_ptr<syncer::SyncChangeProcessor> sync_processor,
+      scoped_ptr<syncer::SyncErrorFactory> error_handler) OVERRIDE;
+  virtual void StopSyncing(syncer::ModelType type) OVERRIDE;
+  virtual syncer::SyncDataList GetAllSyncData(
+      syncer::ModelType type) const OVERRIDE;
+  virtual syncer::SyncError ProcessSyncChanges(
+      const tracked_objects::Location& from_here,
+      const syncer::SyncChangeList& change_list) OVERRIDE;
+
+  // Convert from internal representation to SyncData representation.
+  static const syncer::SyncData CreateSyncDataFromNotification(

[dcheng, 2013/01/25 22:23:48]

const here has no effect.

[Pete Williamson, 2013/01/26 02:17:09]

Done.

+      const SyncedNotification& notification);
+
+  // Convert from SyncData representation to internal representation.
+  static SyncedNotification* CreateNotificationFromSyncData(
+      const syncer::SyncData& sync_data);
+
+  // Add a notification to our list.  This takes ownership of the pointer.
+  void Add(scoped_ptr<notifier::SyncedNotification> notification);

[dcheng, 2013/01/25 22:23:48]

This should be made private. For testing purposes, you can expose a public
AddForTest() version that forwards to Add().

[Pete Williamson, 2013/01/26 02:17:09]

Done.

+
+  void Show(notifier::SyncedNotification* notification);

[dcheng, 2013/01/25 22:23:48]

Ditto. This should be private as well, unless there's a reason non-unit testing
code will be calling this?

[Pete Williamson, 2013/01/26 02:17:09]

Done.

+
+  // Get a pointer to a notification.  ChromeNotifierService owns this pointer.
+  // The caller must not free it.
+  notifier::SyncedNotification* FindNotificationById(const std::string& id);
+
+ private:
+  // Back pointer to the owning profile.
+  Profile* profile_;
+  NotificationUIManager* notification_manager_;
+
+  // TODO(petewil): consider whether a map would better suit our data.
+  // If there are many entries, lookup time may trump locality of reference.
+  ScopedVector<notifier::SyncedNotification> notification_data_;
+
+  DISALLOW_COPY_AND_ASSIGN(ChromeNotifierService);
+};
+
+}  // namespace notifier
+
+#endif  // CHROME_BROWSER_NOTIFIER_CHROME_NOTIFIER_SERVICE_H_