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 // Interface to the sync notifier, which is an object that receives | 5 // Interface to the sync notifier, which is an object that receives |
6 // notifications when updates are available for a set of sync types. | 6 // notifications when updates are available for a set of sync types. |
7 // All the observers are notified when such an event happens. | 7 // All the observers are notified when such an event happens. |
8 | 8 |
9 #ifndef SYNC_NOTIFIER_SYNC_NOTIFIER_H_ | 9 #ifndef SYNC_NOTIFIER_SYNC_NOTIFIER_H_ |
10 #define SYNC_NOTIFIER_SYNC_NOTIFIER_H_ | 10 #define SYNC_NOTIFIER_SYNC_NOTIFIER_H_ |
11 | 11 |
12 #include <string> | 12 #include <string> |
13 | 13 |
14 #include "sync/internal_api/public/base/model_type.h" | 14 #include "sync/internal_api/public/base/model_type.h" |
15 #include "sync/notifier/invalidation_util.h" | 15 #include "sync/notifier/invalidation_util.h" |
16 | 16 |
17 namespace syncer { | 17 namespace syncer { |
18 class SyncNotifierObserver; | 18 class SyncNotifierObserver; |
19 | 19 |
20 class SyncNotifier { | 20 class SyncNotifier { |
21 public: | 21 public: |
22 SyncNotifier() {} | 22 SyncNotifier() {} |
23 virtual ~SyncNotifier() {} | 23 virtual ~SyncNotifier() {} |
24 | 24 |
25 // Updates the set of ObjectIds associated with a given |handler|. | 25 // Clients should follow the pattern below: |
msw
2012/08/09 05:20:26
nit: I wonder if it's good to have this comment in
akalin
2012/08/10 01:28:08
I think it's good to have it in both places for no
| |
26 // Passing an empty ObjectIdSet will unregister |handler|. | 26 // |
27 // There should be at most one handler registered per object id. | 27 // When starting the client: |
28 // | |
29 // notifier->RegisterHandler(client_handler); | |
30 // | |
31 // When the set of IDs to register changes for the client during its lifetime | |
32 // (i.e., between calls to RegisterHandler(client_handler) and | |
33 // UnregisterHandler(client_handler): | |
34 // | |
35 // notifier->UpdateRegisteredIds(client_handler, client_ids); | |
36 // | |
37 // When shutting down the client for browser shutdown: | |
38 // | |
39 // notifier->UnregisterHandler(client_handler); | |
40 // | |
41 // Note that there's no call to UpdateRegisteredIds() -- this is because the | |
42 // invalidation API persists registrations across browser restarts. | |
43 // | |
44 // When permanently shutting down the client, e.g. when disabling the related | |
45 // feature: | |
46 // | |
47 // notifier->UpdateRegisteredIds(client_handler, ObjectIdSet()); | |
48 // notifier->UnregisterHandler(client_handler) | |
msw
2012/08/09 05:20:26
ditto: add trailing semicolon.
akalin
2012/08/10 01:28:08
Done.
| |
49 | |
50 // Starts sending notifications to |handler|. |handler| must not be NULL, | |
51 // and it must not already have been added. | |
52 virtual void RegisterHandler(SyncNotifierObserver* handler) = 0; | |
53 | |
54 // Updates the set of ObjectIds associated with |handler|. |handler| must | |
55 // not be NULL, and must have already been added. An ID must be registered | |
56 // for at most one handler. | |
28 virtual void UpdateRegisteredIds(SyncNotifierObserver* handler, | 57 virtual void UpdateRegisteredIds(SyncNotifierObserver* handler, |
29 const ObjectIdSet& ids) = 0; | 58 const ObjectIdSet& ids) = 0; |
30 | 59 |
60 // Stops sending notifications to |handler|. |handler| must not be NULL, and | |
61 // it must have been previously added. Note that this doesn't unregister the | |
msw
2012/08/09 05:20:26
ditto: s/added/registered/
akalin
2012/08/10 01:28:08
Done.
| |
62 // IDs associated with |handler|. | |
63 virtual void UnregisterHandler(SyncNotifierObserver* handler) = 0; | |
64 | |
31 // SetUniqueId must be called once, before any call to | 65 // SetUniqueId must be called once, before any call to |
32 // UpdateCredentials. |unique_id| should be a non-empty globally | 66 // UpdateCredentials. |unique_id| should be a non-empty globally |
33 // unique string. | 67 // unique string. |
34 virtual void SetUniqueId(const std::string& unique_id) = 0; | 68 virtual void SetUniqueId(const std::string& unique_id) = 0; |
35 | 69 |
36 // SetState must be called once, before any call to | 70 // SetState must be called once, before any call to |
37 // UpdateCredentials. |state| may be empty. | 71 // UpdateCredentials. |state| may be empty. |
38 // Deprecated in favour of InvalidationStateTracker persistence. | 72 // Deprecated in favour of InvalidationStateTracker persistence. |
39 virtual void SetStateDeprecated(const std::string& state) = 0; | 73 virtual void SetStateDeprecated(const std::string& state) = 0; |
40 | 74 |
41 // The observers won't be notified of any notifications until | 75 // The observers won't be notified of any notifications until |
42 // UpdateCredentials is called at least once. It can be called more than | 76 // UpdateCredentials is called at least once. It can be called more than |
43 // once. | 77 // once. |
44 virtual void UpdateCredentials( | 78 virtual void UpdateCredentials( |
45 const std::string& email, const std::string& token) = 0; | 79 const std::string& email, const std::string& token) = 0; |
46 | 80 |
47 // This is here only to support the old p2p notification implementation, | 81 // This is here only to support the old p2p notification implementation, |
48 // which is still used by sync integration tests. | 82 // which is still used by sync integration tests. |
49 // TODO(akalin): Remove this once we move the integration tests off p2p | 83 // TODO(akalin): Remove this once we move the integration tests off p2p |
50 // notifications. | 84 // notifications. |
51 virtual void SendNotification(ModelTypeSet changed_types) = 0; | 85 virtual void SendNotification(ModelTypeSet changed_types) = 0; |
52 }; | 86 }; |
53 } // namespace syncer | 87 } // namespace syncer |
54 | 88 |
55 #endif // SYNC_NOTIFIER_SYNC_NOTIFIER_H_ | 89 #endif // SYNC_NOTIFIER_SYNC_NOTIFIER_H_ |
OLD | NEW |