OLD | NEW |
1 // Copyright 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_INTERNAL_API_PUBLIC_BASE_TRANSACTION_H_ | 5 #ifndef SYNC_INTERNAL_API_PUBLIC_BASE_TRANSACTION_H_ |
6 #define SYNC_INTERNAL_API_PUBLIC_BASE_TRANSACTION_H_ | 6 #define SYNC_INTERNAL_API_PUBLIC_BASE_TRANSACTION_H_ |
7 | 7 |
8 #include "sync/base/sync_export.h" | 8 #include "sync/base/sync_export.h" |
9 #include "sync/internal_api/public/base/model_type.h" | 9 #include "sync/internal_api/public/base/model_type.h" |
10 #include "sync/internal_api/public/user_share.h" | 10 #include "sync/internal_api/public/user_share.h" |
11 #include "sync/util/cryptographer.h" | 11 #include "sync/util/cryptographer.h" |
12 | 12 |
13 namespace syncer { | 13 namespace syncer { |
14 | 14 |
15 namespace syncable { | 15 namespace syncable { |
16 class BaseTransaction; | 16 class BaseTransaction; |
17 class Directory; | 17 class Directory; |
18 } | 18 } |
19 | 19 |
20 // Sync API's BaseTransaction, ReadTransaction, and WriteTransaction allow for | 20 // Sync API's BaseTransaction, ReadTransaction, and WriteTransaction allow for |
21 // batching of several read and/or write operations. The read and write | 21 // batching of several read and/or write operations. The read and write |
22 // operations are performed by creating ReadNode and WriteNode instances using | 22 // operations are performed by creating ReadNode and WriteNode instances using |
23 // the transaction. These transaction classes wrap identically named classes in | 23 // the transaction. These transaction classes wrap identically named classes in |
24 // syncable, and are used in a similar way. Unlike syncable::BaseTransaction, | 24 // syncable, and are used in a similar way. Unlike syncable::BaseTransaction, |
25 // whose construction requires an explicit syncable::Directory, a sync | 25 // whose construction requires an explicit syncable::Directory, a sync |
26 // API BaseTransaction is created from a UserShare object. | 26 // API BaseTransaction is created from a UserShare object. |
| 27 // |
| 28 // Note, these transactions are not atomic. Individual operations can |
| 29 // fail. There is no built-in rollback or undo mechanism. |
27 class SYNC_EXPORT BaseTransaction { | 30 class SYNC_EXPORT BaseTransaction { |
28 public: | 31 public: |
29 // Provide access to the underlying syncable objects from BaseNode. | 32 // Provide access to the underlying syncable objects from BaseNode. |
30 virtual syncable::BaseTransaction* GetWrappedTrans() const = 0; | 33 virtual syncable::BaseTransaction* GetWrappedTrans() const = 0; |
31 Cryptographer* GetCryptographer() const; | 34 Cryptographer* GetCryptographer() const; |
32 ModelTypeSet GetEncryptedTypes() const; | 35 ModelTypeSet GetEncryptedTypes() const; |
33 | 36 |
34 syncable::Directory* GetDirectory() const { | 37 syncable::Directory* GetDirectory() const { |
35 if (!user_share_) { | 38 if (!user_share_) { |
36 return NULL; | 39 return NULL; |
(...skipping 14 matching lines...) Expand all Loading... |
51 | 54 |
52 private: | 55 private: |
53 UserShare* user_share_; | 56 UserShare* user_share_; |
54 | 57 |
55 DISALLOW_COPY_AND_ASSIGN(BaseTransaction); | 58 DISALLOW_COPY_AND_ASSIGN(BaseTransaction); |
56 }; | 59 }; |
57 | 60 |
58 } // namespace syncer | 61 } // namespace syncer |
59 | 62 |
60 #endif // SYNC_INTERNAL_API_PUBLIC_BASE_TRANSACTION_H_ | 63 #endif // SYNC_INTERNAL_API_PUBLIC_BASE_TRANSACTION_H_ |
OLD | NEW |