blob: 7656de89d3f6750d4a2429e381b584834dfbc750 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
// Copyright (c) 2011 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.
#ifndef CHROME_BROWSER_SYNC_API_SYNC_DATA_H_
#define CHROME_BROWSER_SYNC_API_SYNC_DATA_H_
#pragma once
#include <string>
#include <vector>
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "chrome/browser/sync/syncable/model_type.h"
namespace sync_pb {
class EntitySpecifics;
class SyncEntity;
}
typedef syncable::ModelType SyncDataType;
// A light-weight container for immutable sync data. Pass-by-value and storage
// in STL containers are supported and encouraged if helpful.
class SyncData {
public:
// Creates an empty and invalid SyncData.
SyncData();
~SyncData();
// Default copy and assign welcome.
// Helper methods for creating SyncData objects for local data.
// Local sync data must always at least set the sync tag (which must be a
// string unique to this datatype), for use as a node identifier server-side.
// For adds/updates, the actual sync data that is changing (in the form of
// sync_pb::EntitySpecifics) and a human-readable/non-unique title (can be the
// same as sync tag) must also specfied.
// Note: the non_unique_title is primarily for debug purposes, and will be
// overwritten if the datatype is encrypted.
// For deletes:
static SyncData CreateLocalData(const std::string& sync_tag);
// For adds/updates:
static SyncData CreateLocalData(
const std::string& sync_tag,
const std::string& non_unique_title,
const sync_pb::EntitySpecifics& specifics);
// Helper methods for creating SyncData objects originating from the syncer.
static SyncData CreateRemoteData(
const sync_pb::SyncEntity& entity);
static SyncData CreateRemoteData(
const sync_pb::EntitySpecifics& specifics);
// Whether this SyncData holds valid data. The only way to have a SyncData
// without valid data is to use the default constructor.
bool IsValid() const;
// Return the datatype we're holding information about. Derived from the sync
// datatype specifics.
SyncDataType GetDataType() const;
// Return the current sync datatype specifics.
const sync_pb::EntitySpecifics& GetSpecifics() const;
// Returns the value of the unique client tag. This is only set for data going
// TO the syncer, not coming from.
const std::string& GetTag() const;
// Returns the non unique title (for debugging). Currently only set for data
// going TO the syncer, not from.
const std::string& GetTitle() const;
// Whether this sync data is for local data or data coming from the syncer.
bool IsLocal() const;
// TODO(zea): Query methods for other sync properties: parent, successor, etc.
private:
// A reference counted immutable SyncEntity.
class SharedSyncEntity : public
base::RefCountedThreadSafe<SharedSyncEntity> {
public:
// Takes ownership of |sync_entity|'s contents.
explicit SharedSyncEntity(sync_pb::SyncEntity* sync_entity);
// Returns immutable reference to local sync entity.
const sync_pb::SyncEntity& sync_entity() const;
private:
friend class base::RefCountedThreadSafe<SharedSyncEntity>;
// Private due to ref counting.
~SharedSyncEntity();
scoped_ptr<sync_pb::SyncEntity> sync_entity_;
};
// The actual shared sync entity being held.
scoped_refptr<SharedSyncEntity> shared_entity_;
// Whether this data originated locally or from the syncer (remote data).
bool is_local_;
};
#endif // CHROME_BROWSER_SYNC_API_SYNC_DATA_H_
|
