blob: e1000419b9fd5c42bce9a8e8d4f243133744cbe6 [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 "base/basictypes.h"
#include "base/compiler_specific.h"
#include "sync/api/sync_change_processor.h"
#include "sync/base/sync_export.h"
#include "sync/internal_api/public/base_transaction.h"
namespace tracked_objects {
class Location;
} // namespace tracked_objects
namespace syncer {
namespace syncable {
class BaseTransaction;
class WriteTransaction;
} // namespace syncable
// Sync API's WriteTransaction is a read/write BaseTransaction. It wraps
// a syncable::WriteTransaction.
// NOTE: Only a single model type can be mutated for a given
// WriteTransaction.
class SYNC_EXPORT WriteTransaction : public BaseTransaction {
// Start a new read/write transaction.
WriteTransaction(const tracked_objects::Location& from_here,
UserShare* share);
// |transaction_version| stores updated model and nodes version if model
// is changed by the transaction, or syncer::syncable::kInvalidTransaction
// if not after transaction is closed. This constructor is used for model
// types that support embassy data.
WriteTransaction(const tracked_objects::Location& from_here,
UserShare* share, int64* transaction_version);
virtual ~WriteTransaction();
// Provide access to the syncable transaction from the API WriteNode.
virtual syncable::BaseTransaction* GetWrappedTrans() const override;
syncable::WriteTransaction* GetWrappedWriteTrans() { return transaction_; }
// Set's a |type|'s local context. |refresh_status| controls whether
// a datatype refresh is performed (clearing the progress marker token and
// setting the version of all synced entities to 1).
void SetDataTypeContext(
ModelType type,
syncer::SyncChangeProcessor::ContextRefreshStatus refresh_status,
const std::string& context);
// Update all entries that refer to |attachment_id| indicating that
// |attachment_id| has been uploaded to the sync server.
void UpdateEntriesMarkAttachmentAsOnServer(const AttachmentId& attachment_id);
WriteTransaction() {}
void SetTransaction(syncable::WriteTransaction* trans) {
transaction_ = trans;
void* operator new(size_t size); // Transaction is meant for stack use only.
// The underlying syncable object which this class wraps.
syncable::WriteTransaction* transaction_;
} // namespace syncer