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_READ_TRANSACTION_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define SYNC_INTERNAL_API_PUBLIC_READ_TRANSACTION_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 91320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "sync/api/attachments/attachment_id.h" 102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "sync/base/sync_export.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sync/internal_api/public/base_transaction.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace tracked_objects { 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Location; 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace tracked_objects 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17a02191e04bc25c4935f804f2c080ae28663d096dBen Murdochnamespace sync_pb { 18a02191e04bc25c4935f804f2c080ae28663d096dBen Murdochclass DataTypeContext; 19a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch} 20a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace syncer { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct UserShare; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Sync API's ReadTransaction is a read-only BaseTransaction. It wraps 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// a syncable::ReadTransaction. 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class SYNC_EXPORT ReadTransaction : public BaseTransaction { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Start a new read-only transaction on the specified repository. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ReadTransaction(const tracked_objects::Location& from_here, 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UserShare* share); 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Resume the middle of a transaction. Will not close transaction. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ReadTransaction(UserShare* share, syncable::BaseTransaction* trans); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ReadTransaction(); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BaseTransaction override. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual syncable::BaseTransaction* GetWrappedTrans() const OVERRIDE; 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return |transaction_version| of |type| stored in sync directory's 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // persisted info. 43a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch int64 GetModelVersion(ModelType type) const; 44a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch 45a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch // Fills |context| with the datatype context associated with |type|. 46a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch void GetDataTypeContext(ModelType type, 47a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch sync_pb::DataTypeContext* context) const; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 491320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // Clears |id_set| and fills it with the ids of attachments that need to be 501320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // uploaded to the sync server. 511320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci void GetAttachmentIdsToUpload(ModelType type, AttachmentIdSet* id_set); 521320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void* operator new(size_t size); // Transaction is meant for stack use only. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The underlying syncable object which this class wraps. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncable::BaseTransaction* transaction_; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool close_transaction_; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ReadTransaction); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace syncer 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // SYNC_INTERNAL_API_PUBLIC_READ_TRANSACTION_H_ 66