OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 // | 4 // |
5 // Sync protocol for communication between sync client and server. | 5 // Sync protocol for communication between sync client and server. |
6 | 6 |
7 // Update proto_value_conversions{.h,.cc,_unittest.cc} if you change | 7 // Update proto_value_conversions{.h,.cc,_unittest.cc} if you change |
8 // any fields in this file. | 8 // any fields in this file. |
9 | 9 |
10 syntax = "proto2"; | 10 syntax = "proto2"; |
(...skipping 161 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
172 // will interpret this entity as a newly-created item and generate a | 172 // will interpret this entity as a newly-created item and generate a |
173 // new server ID and an initial version number. If nonzero in a | 173 // new server ID and an initial version number. If nonzero in a |
174 // CommitMessage, this item is treated as an update to an existing item, and | 174 // CommitMessage, this item is treated as an update to an existing item, and |
175 // the server will use |id_string| to locate the item. Then, if the item's | 175 // the server will use |id_string| to locate the item. Then, if the item's |
176 // current version on the server does not match |version|, the commit will | 176 // current version on the server does not match |version|, the commit will |
177 // fail for that item. The server will not update it, and will return | 177 // fail for that item. The server will not update it, and will return |
178 // a result code of CONFLICT. In a GetUpdatesResponse, |version| is | 178 // a result code of CONFLICT. In a GetUpdatesResponse, |version| is |
179 // always positive and indentifies the revision of the item data being sent | 179 // always positive and indentifies the revision of the item data being sent |
180 // to the client. | 180 // to the client. |
181 // Present in both GetUpdatesResponse and CommitMessage. | 181 // Present in both GetUpdatesResponse and CommitMessage. |
182 required int64 version = 4; | 182 // WARNING: This field used to be required before M60. Any client before this |
| 183 // will fail to deserialize if this field is missing. |
| 184 optional int64 version = 4; |
183 | 185 |
184 // Last modification time (in java time milliseconds) | 186 // Last modification time (in java time milliseconds) |
185 // Present in both GetUpdatesResponse and CommitMessage. | 187 // Present in both GetUpdatesResponse and CommitMessage. |
186 optional int64 mtime = 5; | 188 optional int64 mtime = 5; |
187 | 189 |
188 // Creation time. | 190 // Creation time. |
189 // Present in both GetUpdatesResponse and CommitMessage. | 191 // Present in both GetUpdatesResponse and CommitMessage. |
190 optional int64 ctime = 6; | 192 optional int64 ctime = 6; |
191 | 193 |
192 // The name of this item. | 194 // The name of this item. |
193 // Historical note: | 195 // Historical note: |
194 // Since November 2010, this value is no different from non_unique_name. | 196 // Since November 2010, this value is no different from non_unique_name. |
195 // Before then, server implementations would maintain a unique-within-parent | 197 // Before then, server implementations would maintain a unique-within-parent |
196 // value separate from its base, "non-unique" value. Clients had not | 198 // value separate from its base, "non-unique" value. Clients had not |
197 // depended on the uniqueness of the property since November 2009; it was | 199 // depended on the uniqueness of the property since November 2009; it was |
198 // removed from Chromium by http://codereview.chromium.org/371029 . | 200 // removed from Chromium by http://codereview.chromium.org/371029 . |
199 // Present in both GetUpdatesResponse and CommitMessage. | 201 // Present in both GetUpdatesResponse and CommitMessage. |
200 required string name = 7; | 202 // WARNING: This field used to be required before M60. Any client before this |
| 203 // will fail to deserialize if this field is missing. |
| 204 optional string name = 7; |
201 | 205 |
202 // The name of this item. Same as |name|. | 206 // The name of this item. Same as |name|. |
203 // |non_unique_name| should take precedence over the |name| value if both | 207 // |non_unique_name| should take precedence over the |name| value if both |
204 // are supplied. For efficiency, clients and servers should avoid setting | 208 // are supplied. For efficiency, clients and servers should avoid setting |
205 // this redundant value. | 209 // this redundant value. |
206 // Present in both GetUpdatesResponse and CommitMessage. | 210 // Present in both GetUpdatesResponse and CommitMessage. |
207 optional string non_unique_name = 8; | 211 optional string non_unique_name = 8; |
208 | 212 |
209 // A value from a monotonically increasing sequence that indicates when | 213 // A value from a monotonically increasing sequence that indicates when |
210 // this item was last updated on the server. This is now equivalent | 214 // this item was last updated on the server. This is now equivalent |
(...skipping 747 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
958 required string email = 1; // the user's full primary email address. | 962 required string email = 1; // the user's full primary email address. |
959 optional string display_name = 2; // the user's display name. | 963 optional string display_name = 2; // the user's display name. |
960 optional string obfuscated_id = 3; // an obfuscated, opaque user id. | 964 optional string obfuscated_id = 3; // an obfuscated, opaque user id. |
961 }; | 965 }; |
962 | 966 |
963 message AuthenticateResponse { | 967 message AuthenticateResponse { |
964 // Optional only for backward compatibility. | 968 // Optional only for backward compatibility. |
965 optional UserIdentification user = 1; | 969 optional UserIdentification user = 1; |
966 }; | 970 }; |
967 | 971 |
968 message ThrottleParameters { | |
969 // Deprecated. Remove this from the server side. | |
970 required int32 min_measure_payload_size = 1; | |
971 required double target_utilization = 2; | |
972 required double measure_interval_max = 3; | |
973 required double measure_interval_min = 4; | |
974 required double observation_window = 5; | |
975 }; | |
976 | |
977 message ClientToServerResponse { | 972 message ClientToServerResponse { |
978 optional CommitResponse commit = 1; | 973 optional CommitResponse commit = 1; |
979 optional GetUpdatesResponse get_updates = 2; | 974 optional GetUpdatesResponse get_updates = 2; |
980 optional AuthenticateResponse authenticate = 3; | 975 optional AuthenticateResponse authenticate = 3; |
981 | 976 |
982 // Up until protocol_version 24, the default was SUCCESS which made it | 977 // Up until protocol_version 24, the default was SUCCESS which made it |
983 // impossible to add new enum values since older clients would parse any | 978 // impossible to add new enum values since older clients would parse any |
984 // out-of-range value as SUCCESS. Starting with 25, unless explicitly set, | 979 // out-of-range value as SUCCESS. Starting with 25, unless explicitly set, |
985 // the error_code will be UNKNOWN so that clients know when they're | 980 // the error_code will be UNKNOWN so that clients know when they're |
986 // out-of-date. Note also that when using protocol_version < 25, | 981 // out-of-date. Note also that when using protocol_version < 25, |
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1040 message EventResponse {}; | 1035 message EventResponse {}; |
1041 | 1036 |
1042 // A message indicating that the sync engine has been disabled on a client. | 1037 // A message indicating that the sync engine has been disabled on a client. |
1043 message SyncDisabledEvent { | 1038 message SyncDisabledEvent { |
1044 // The GUID that identifies the sync client. | 1039 // The GUID that identifies the sync client. |
1045 optional string cache_guid = 1; | 1040 optional string cache_guid = 1; |
1046 | 1041 |
1047 // The store birthday that the client was using before disabling sync. | 1042 // The store birthday that the client was using before disabling sync. |
1048 optional string store_birthday = 2; | 1043 optional string store_birthday = 2; |
1049 }; | 1044 }; |
OLD | NEW |