OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 // | 4 // |
5 // An implementation of SyncNotifier that wraps an invalidation | 5 // An implementation of SyncNotifier that wraps an invalidation |
6 // client. Handles the details of connecting to XMPP and hooking it | 6 // client. Handles the details of connecting to XMPP and hooking it |
7 // up to the invalidation client. | 7 // up to the invalidation client. |
8 // | 8 // |
9 // You probably don't want to use this directly; use | 9 // You probably don't want to use this directly; use |
10 // NonBlockingInvalidationNotifier. | 10 // NonBlockingInvalidationNotifier. |
11 | 11 |
12 #ifndef SYNC_NOTIFIER_INVALIDATION_NOTIFIER_H_ | 12 #ifndef SYNC_NOTIFIER_INVALIDATION_NOTIFIER_H_ |
13 #define SYNC_NOTIFIER_INVALIDATION_NOTIFIER_H_ | 13 #define SYNC_NOTIFIER_INVALIDATION_NOTIFIER_H_ |
14 | 14 |
15 #include <string> | 15 #include <string> |
16 | 16 |
17 #include "base/basictypes.h" | 17 #include "base/basictypes.h" |
18 #include "base/compiler_specific.h" | 18 #include "base/compiler_specific.h" |
19 #include "base/memory/scoped_ptr.h" | 19 #include "base/memory/scoped_ptr.h" |
20 #include "base/observer_list.h" | |
21 #include "base/threading/non_thread_safe.h" | 20 #include "base/threading/non_thread_safe.h" |
22 #include "sync/internal_api/public/base/model_type.h" | 21 #include "sync/internal_api/public/base/model_type.h" |
23 #include "sync/internal_api/public/util/weak_handle.h" | 22 #include "sync/internal_api/public/util/weak_handle.h" |
24 #include "sync/notifier/chrome_invalidation_client.h" | 23 #include "sync/notifier/chrome_invalidation_client.h" |
25 #include "sync/notifier/invalidation_state_tracker.h" | 24 #include "sync/notifier/invalidation_state_tracker.h" |
26 #include "sync/notifier/sync_notifier.h" | 25 #include "sync/notifier/sync_notifier.h" |
| 26 #include "sync/notifier/sync_notifier_helper.h" |
27 | 27 |
28 namespace notifier { | 28 namespace notifier { |
29 class PushClient; | 29 class PushClient; |
30 } // namespace notifier | 30 } // namespace notifier |
31 | 31 |
32 namespace syncer { | 32 namespace syncer { |
33 | 33 |
34 // This class must live on the IO thread. | 34 // This class must live on the IO thread. |
35 class InvalidationNotifier | 35 class InvalidationNotifier |
36 : public SyncNotifier, | 36 : public SyncNotifier, |
37 public ChromeInvalidationClient::Listener, | 37 public ChromeInvalidationClient::Listener, |
38 public base::NonThreadSafe { | 38 public base::NonThreadSafe { |
39 public: | 39 public: |
40 // |invalidation_state_tracker| must be initialized. | 40 // |invalidation_state_tracker| must be initialized. |
41 InvalidationNotifier( | 41 InvalidationNotifier( |
42 scoped_ptr<notifier::PushClient> push_client, | 42 scoped_ptr<notifier::PushClient> push_client, |
43 const InvalidationVersionMap& initial_max_invalidation_versions, | 43 const InvalidationVersionMap& initial_max_invalidation_versions, |
44 const std::string& initial_invalidation_state, | 44 const std::string& initial_invalidation_state, |
45 const WeakHandle<InvalidationStateTracker>& | 45 const WeakHandle<InvalidationStateTracker>& |
46 invalidation_state_tracker, | 46 invalidation_state_tracker, |
47 const std::string& client_info); | 47 const std::string& client_info); |
48 | 48 |
49 virtual ~InvalidationNotifier(); | 49 virtual ~InvalidationNotifier(); |
50 | 50 |
51 // SyncNotifier implementation. | 51 // SyncNotifier implementation. |
52 virtual void AddObserver(SyncNotifierObserver* observer) OVERRIDE; | 52 virtual void UpdateRegisteredIds(SyncNotifierObserver* handler, |
53 virtual void RemoveObserver(SyncNotifierObserver* observer) OVERRIDE; | 53 const ObjectIdSet& ids) OVERRIDE; |
54 virtual void SetUniqueId(const std::string& unique_id) OVERRIDE; | 54 virtual void SetUniqueId(const std::string& unique_id) OVERRIDE; |
55 virtual void SetStateDeprecated(const std::string& state) OVERRIDE; | 55 virtual void SetStateDeprecated(const std::string& state) OVERRIDE; |
56 virtual void UpdateCredentials( | 56 virtual void UpdateCredentials( |
57 const std::string& email, const std::string& token) OVERRIDE; | 57 const std::string& email, const std::string& token) OVERRIDE; |
58 virtual void UpdateEnabledTypes(ModelTypeSet enabled_types) OVERRIDE; | |
59 virtual void SendNotification(ModelTypeSet changed_types) OVERRIDE; | 58 virtual void SendNotification(ModelTypeSet changed_types) OVERRIDE; |
60 | 59 |
61 // ChromeInvalidationClient::Listener implementation. | 60 // ChromeInvalidationClient::Listener implementation. |
62 virtual void OnInvalidate(const ObjectIdPayloadMap& id_payloads) OVERRIDE; | 61 virtual void OnInvalidate(const ObjectIdPayloadMap& id_payloads) OVERRIDE; |
63 virtual void OnNotificationsEnabled() OVERRIDE; | 62 virtual void OnNotificationsEnabled() OVERRIDE; |
64 virtual void OnNotificationsDisabled( | 63 virtual void OnNotificationsDisabled( |
65 NotificationsDisabledReason reason) OVERRIDE; | 64 NotificationsDisabledReason reason) OVERRIDE; |
66 | 65 |
67 private: | 66 private: |
68 // We start off in the STOPPED state. When we get our initial | 67 // We start off in the STOPPED state. When we get our initial |
69 // credentials, we connect and move to the CONNECTING state. When | 68 // credentials, we connect and move to the CONNECTING state. When |
70 // we're connected we start the invalidation client and move to the | 69 // we're connected we start the invalidation client and move to the |
71 // STARTED state. We never go back to a previous state. | 70 // STARTED state. We never go back to a previous state. |
72 enum State { | 71 enum State { |
73 STOPPED, | 72 STOPPED, |
74 CONNECTING, | 73 CONNECTING, |
75 STARTED | 74 STARTED |
76 }; | 75 }; |
77 State state_; | 76 State state_; |
78 | 77 |
| 78 SyncNotifierHelper helper_; |
| 79 |
79 // Passed to |invalidation_client_|. | 80 // Passed to |invalidation_client_|. |
80 const InvalidationVersionMap initial_max_invalidation_versions_; | 81 const InvalidationVersionMap initial_max_invalidation_versions_; |
81 | 82 |
82 // Passed to |invalidation_client_|. | 83 // Passed to |invalidation_client_|. |
83 const WeakHandle<InvalidationStateTracker> | 84 const WeakHandle<InvalidationStateTracker> |
84 invalidation_state_tracker_; | 85 invalidation_state_tracker_; |
85 | 86 |
86 // Passed to |invalidation_client_|. | 87 // Passed to |invalidation_client_|. |
87 const std::string client_info_; | 88 const std::string client_info_; |
88 | 89 |
89 // Our observers (which must live on the same thread). | |
90 ObserverList<SyncNotifierObserver> observers_; | |
91 | |
92 // The client ID to pass to |chrome_invalidation_client_|. | 90 // The client ID to pass to |chrome_invalidation_client_|. |
93 std::string invalidation_client_id_; | 91 std::string invalidation_client_id_; |
94 | 92 |
95 // The state to pass to |chrome_invalidation_client_|. | 93 // The state to pass to |chrome_invalidation_client_|. |
96 // TODO(tim): This should be made const once migration is completed for bug | 94 // TODO(tim): This should be made const once migration is completed for bug |
97 // 124140. | 95 // 124140. |
98 std::string invalidation_state_; | 96 std::string invalidation_state_; |
99 | 97 |
100 // The invalidation client. | 98 // The invalidation client. |
101 ChromeInvalidationClient invalidation_client_; | 99 ChromeInvalidationClient invalidation_client_; |
102 | 100 |
103 DISALLOW_COPY_AND_ASSIGN(InvalidationNotifier); | 101 DISALLOW_COPY_AND_ASSIGN(InvalidationNotifier); |
104 }; | 102 }; |
105 | 103 |
106 } // namespace syncer | 104 } // namespace syncer |
107 | 105 |
108 #endif // SYNC_NOTIFIER_INVALIDATION_NOTIFIER_H_ | 106 #endif // SYNC_NOTIFIER_INVALIDATION_NOTIFIER_H_ |
OLD | NEW |