blob: c75086e526f6e3fb2d1b12c248fec925c9638b34 [file] [log] [blame]
// Copyright 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.
#include "sync/base/sync_export.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/user_share.h"
#include "sync/util/cryptographer.h"
namespace syncer {
namespace syncable {
class BaseTransaction;
class Directory;
// Sync API's BaseTransaction, ReadTransaction, and WriteTransaction allow for
// batching of several read and/or write operations. The read and write
// operations are performed by creating ReadNode and WriteNode instances using
// the transaction. These transaction classes wrap identically named classes in
// syncable, and are used in a similar way. Unlike syncable::BaseTransaction,
// whose construction requires an explicit syncable::Directory, a sync
// API BaseTransaction is created from a UserShare object.
// Note, these transactions are not atomic. Individual operations can
// fail. There is no built-in rollback or undo mechanism.
class SYNC_EXPORT BaseTransaction {
// Provide access to the underlying syncable objects from BaseNode.
virtual syncable::BaseTransaction* GetWrappedTrans() const = 0;
Cryptographer* GetCryptographer() const;
ModelTypeSet GetEncryptedTypes() const;
syncable::Directory* GetDirectory() const {
if (!user_share_) {
return NULL;
} else {
return user_share_->directory.get();
UserShare* GetUserShare() const {
return user_share_;
explicit BaseTransaction(UserShare* share);
virtual ~BaseTransaction();
BaseTransaction() : user_share_(NULL) { }
UserShare* user_share_;
} // namespace syncer