12a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Copyright 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef SYNC_INTERNAL_API_PUBLIC_WRITE_TRANSACTION_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define SYNC_INTERNAL_API_PUBLIC_WRITE_TRANSACTION_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 10c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch#include "sync/api/sync_change_processor.h" 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "sync/base/sync_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sync/internal_api/public/base_transaction.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace tracked_objects { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Location; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace tracked_objects 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace syncer { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace syncable { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BaseTransaction; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class WriteTransaction; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace syncable 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Sync API's WriteTransaction is a read/write BaseTransaction. It wraps 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// a syncable::WriteTransaction. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// NOTE: Only a single model type can be mutated for a given 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// WriteTransaction. 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class SYNC_EXPORT WriteTransaction : public BaseTransaction { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Start a new read/write transaction. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WriteTransaction(const tracked_objects::Location& from_here, 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UserShare* share); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |transaction_version| stores updated model and nodes version if model 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is changed by the transaction, or syncer::syncable::kInvalidTransaction 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if not after transaction is closed. This constructor is used for model 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // types that support embassy data. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WriteTransaction(const tracked_objects::Location& from_here, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UserShare* share, int64* transaction_version); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~WriteTransaction(); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Provide access to the syncable transaction from the API WriteNode. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual syncable::BaseTransaction* GetWrappedTrans() const OVERRIDE; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncable::WriteTransaction* GetWrappedWriteTrans() { return transaction_; } 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 47c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch // Set's a |type|'s local context. |refresh_status| controls whether 48c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch // a datatype refresh is performed (clearing the progress marker token and 49c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch // setting the version of all synced entities to 1). 50c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch void SetDataTypeContext( 51c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch ModelType type, 52c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch syncer::SyncChangeProcessor::ContextRefreshStatus refresh_status, 53c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch const std::string& context); 54c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch 55116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Update all entries that refer to |attachment_id| indicating that 56116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // |attachment_id| has been uploaded to the sync server. 57116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void UpdateEntriesMarkAttachmentAsOnServer(const AttachmentId& attachment_id); 58cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WriteTransaction() {} 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetTransaction(syncable::WriteTransaction* trans) { 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transaction_ = trans; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void* operator new(size_t size); // Transaction is meant for stack use only. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The underlying syncable object which this class wraps. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncable::WriteTransaction* transaction_; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(WriteTransaction); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace syncer 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // SYNC_INTERNAL_API_PUBLIC_WRITE_TRANSACTION_H_ 78