FYI: Control Data + Per-Device Metadata

sync/internal_api/public/base_node.h

 // Copyright (c) 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.
 
 #ifndef SYNC_INTERNAL_API_PUBLIC_BASE_NODE_H_
 #define SYNC_INTERNAL_API_PUBLIC_BASE_NODE_H_
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "googleurl/src/gurl.h"
 #include "sync/internal_api/public/base/model_type.h"
 #include "sync/protocol/sync.pb.h"
 
 // Forward declarations of internal class types so that sync API objects
 // may have opaque pointers to these types.
 namespace base {
 class DictionaryValue;
 }
 
 namespace sync_pb {
 class AppSpecifics;
+class AutofillProfileSpecifics;
 class AutofillSpecifics;
-class AutofillProfileSpecifics;
 class BookmarkSpecifics;
 class EntitySpecifics;
 class ExtensionSpecifics;
+class NigoriSpecifics;
+class PasswordSpecificsData;
+class PerDeviceSpecifics;
+class PerUserSpecifics;
+class PreferenceSpecifics;
 class SessionSpecifics;
-class NigoriSpecifics;
-class PreferenceSpecifics;
-class PasswordSpecificsData;
 class ThemeSpecifics;
 class TypedUrlSpecifics;
 }
 
 namespace syncer {
 
 class BaseTransaction;
 
 namespace syncable {
 class BaseTransaction;
@@ skipping 113 matching lines @@
   const sync_pb::TypedUrlSpecifics& GetTypedUrlSpecifics() const;
 
   // Getter specific to the EXTENSIONS datatype.  Returns protobuf
   // data.  Can only be called if GetModelType() == EXTENSIONS.
   const sync_pb::ExtensionSpecifics& GetExtensionSpecifics() const;
 
   // Getter specific to the SESSIONS datatype.  Returns protobuf
   // data.  Can only be called if GetModelType() == SESSIONS.
   const sync_pb::SessionSpecifics& GetSessionSpecifics() const;
 
+  // Getter specific to the PER_DEVICE_METADATA datatype.  Returns protobuf
+  // data.  Can only be called if GetModelType() == PER_DEVICE_METADATA.
+  const sync_pb::PerDeviceSpecifics& GetPerDeviceSpecifics() const;
+
+  // Getter specific to the PER_USER_METADATA datatype.  Returns protobuf data.
+  // Can only be called if GetModelType() == PER_USERMETADATA.

[rlarocque, 2012/08/11 01:31:52]

FIXME: typo.

+  const sync_pb::PerUserSpecifics& GetPerUserSpecifics() const;

[rlarocque, 2012/08/11 01:31:52]

I'm not sure if this function is necessary.  According to the original design
doc, there's no need for a PerUserSpecifics, since it would always contain
exactly one sub-message and the caller would have to know which one it is.  It
might be easier to just expect the caller to call GetEntitySpecifics and place
all possible sub-messages directly under sync_pb::EntitySpecifics.

That might have undesirable effects on other parts of the code that expect
types' protobufs to be formatted a certain way, ie. proto_value_conversions.cc. 
Maybe it would be better to use slightly uglier protobuf definitions in order to
not disturb the existing code too much.

Server devs: any thoughts?

+
   const sync_pb::EntitySpecifics& GetEntitySpecifics() const;
 
   // Returns the local external ID associated with the node.
   int64 GetExternalId() const;
 
   // Returns true iff this node has children.
   bool HasChildren() const;
 
   // Return the ID of the node immediately before this in the sibling order.
   // For the first node in the ordering, return 0.
@@ skipping 68 matching lines @@
 
   // Same as |unencrypted_data_|, but for legacy password encryption.
   scoped_ptr<sync_pb::PasswordSpecificsData> password_data_;
 
   DISALLOW_COPY_AND_ASSIGN(BaseNode);
 };
 
 }  // namespace syncer
 
 #endif  // SYNC_INTERNAL_API_PUBLIC_BASE_NODE_H_