1// Copyright 2014 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef SYNC_API_ATTACHMENTS_ATTACHMENT_H_ 6#define SYNC_API_ATTACHMENTS_ATTACHMENT_H_ 7 8#include <map> 9#include <vector> 10 11#include "base/basictypes.h" 12#include "base/memory/ref_counted.h" 13#include "base/memory/ref_counted_memory.h" 14#include "base/memory/scoped_ptr.h" 15#include "sync/api/attachments/attachment_id.h" 16#include "sync/base/sync_export.h" 17 18namespace syncer { 19 20// A blob of in-memory data attached to a sync item. 21// 22// While Attachment objects themselves aren't immutable (they are assignable) 23// the data they wrap is immutable. 24// 25// It is cheap to copy Attachments. Feel free to store and return by value. 26class SYNC_EXPORT Attachment { 27 public: 28 ~Attachment(); 29 30 // Default copy and assignment are welcome. 31 32 // Creates an attachment with a unique id and the supplied data. 33 // 34 // Used when creating a brand new attachment. 35 static Attachment Create(const scoped_refptr<base::RefCountedMemory>& data); 36 37 // Creates an attachment with the supplied id and data. 38 // 39 // Used when you want to recreate a specific attachment. E.g. creating a local 40 // copy of an attachment that already exists on the sync server. 41 static Attachment CreateWithId( 42 const AttachmentId& id, 43 const scoped_refptr<base::RefCountedMemory>& data); 44 45 // Returns this attachment's id. 46 const AttachmentId& GetId() const; 47 48 // Returns this attachment's data. 49 const scoped_refptr<base::RefCountedMemory>& GetData() const; 50 51 private: 52 AttachmentId id_; 53 scoped_refptr<base::RefCountedMemory> data_; 54 55 Attachment(const AttachmentId& id, 56 const scoped_refptr<base::RefCountedMemory>& data); 57}; 58 59typedef std::vector<syncer::Attachment> AttachmentList; 60typedef std::map<AttachmentId, Attachment> AttachmentMap; 61 62} // namespace syncer 63 64#endif // SYNC_API_ATTACHMENTS_ATTACHMENT_H_ 65