OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright 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 #ifndef SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_ | 5 #ifndef SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_ |
6 #define SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_ | 6 #define SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_ |
7 | 7 |
| 8 #include "sync/base/sync_export.h" |
8 #include "sync/internal_api/public/base/model_type.h" | 9 #include "sync/internal_api/public/base/model_type.h" |
9 #include "sync/syncable/write_transaction_info.h" | 10 #include "sync/syncable/write_transaction_info.h" |
10 | 11 |
11 namespace syncer { | 12 namespace syncer { |
12 namespace syncable { | 13 namespace syncable { |
13 | 14 |
14 // This is an interface for listening to directory change events, triggered by | 15 // This is an interface for listening to directory change events, triggered by |
15 // the releasing of the syncable transaction. The delegate performs work to | 16 // the releasing of the syncable transaction. The delegate performs work to |
16 // 1. Calculate changes, depending on the source of the transaction | 17 // 1. Calculate changes, depending on the source of the transaction |
17 // (HandleCalculateChangesChangeEventFromSyncer/Syncapi). | 18 // (HandleCalculateChangesChangeEventFromSyncer/Syncapi). |
18 // 2. Perform final work while the transaction is held | 19 // 2. Perform final work while the transaction is held |
19 // (HandleTransactionEndingChangeEvent). | 20 // (HandleTransactionEndingChangeEvent). |
20 // 3. Perform any work that should be done after the transaction is released. | 21 // 3. Perform any work that should be done after the transaction is released. |
21 // (HandleTransactionCompleteChangeEvent). | 22 // (HandleTransactionCompleteChangeEvent). |
22 // | 23 // |
23 // Note that these methods may be called on *any* thread. | 24 // Note that these methods may be called on *any* thread. |
24 class DirectoryChangeDelegate { | 25 class SYNC_EXPORT_PRIVATE DirectoryChangeDelegate { |
25 public: | 26 public: |
26 // Returns the handles of changed entries in |entry_changed|. | 27 // Returns the handles of changed entries in |entry_changed|. |
27 virtual void HandleCalculateChangesChangeEventFromSyncApi( | 28 virtual void HandleCalculateChangesChangeEventFromSyncApi( |
28 const ImmutableWriteTransactionInfo& write_transaction_info, | 29 const ImmutableWriteTransactionInfo& write_transaction_info, |
29 BaseTransaction* trans, | 30 BaseTransaction* trans, |
30 std::vector<int64>* entries_changed) = 0; | 31 std::vector<int64>* entries_changed) = 0; |
31 // Returns the handles of changed entries in |entry_changed|. | 32 // Returns the handles of changed entries in |entry_changed|. |
32 virtual void HandleCalculateChangesChangeEventFromSyncer( | 33 virtual void HandleCalculateChangesChangeEventFromSyncer( |
33 const ImmutableWriteTransactionInfo& write_transaction_info, | 34 const ImmutableWriteTransactionInfo& write_transaction_info, |
34 BaseTransaction* trans, | 35 BaseTransaction* trans, |
35 std::vector<int64>* entries_changed) = 0; | 36 std::vector<int64>* entries_changed) = 0; |
36 // Must return the set of all ModelTypes that were modified in the | 37 // Must return the set of all ModelTypes that were modified in the |
37 // transaction. | 38 // transaction. |
38 virtual ModelTypeSet HandleTransactionEndingChangeEvent( | 39 virtual ModelTypeSet HandleTransactionEndingChangeEvent( |
39 const ImmutableWriteTransactionInfo& write_transaction_info, | 40 const ImmutableWriteTransactionInfo& write_transaction_info, |
40 BaseTransaction* trans) = 0; | 41 BaseTransaction* trans) = 0; |
41 virtual void HandleTransactionCompleteChangeEvent( | 42 virtual void HandleTransactionCompleteChangeEvent( |
42 ModelTypeSet models_with_changes) = 0; | 43 ModelTypeSet models_with_changes) = 0; |
43 protected: | 44 protected: |
44 virtual ~DirectoryChangeDelegate() {} | 45 virtual ~DirectoryChangeDelegate() {} |
45 }; | 46 }; |
46 | 47 |
47 } // namespace syncable | 48 } // namespace syncable |
48 } // namespace syncer | 49 } // namespace syncer |
49 | 50 |
50 #endif // SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_ | 51 #endif // SYNC_SYNCABLE_DIRECTORY_CHANGE_DELEGATE_H_ |
OLD | NEW |