OLD | NEW |
1 // Copyright (c) 2009 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2009 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 syntax = "proto2"; | 7 syntax = "proto2"; |
8 | 8 |
9 // TODO(akalin): Re-enable this once LITE_RUNTIME supports preserving | 9 // TODO(akalin): Re-enable this once LITE_RUNTIME supports preserving |
10 // unknown fields. | 10 // unknown fields. |
(...skipping 214 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
225 // May be present in CommitMessages for the initial creation of an entity. | 225 // May be present in CommitMessages for the initial creation of an entity. |
226 // If present in Commit updates for the entity, it will be ignored. | 226 // If present in Commit updates for the entity, it will be ignored. |
227 // | 227 // |
228 // Available in version 24+. | 228 // Available in version 24+. |
229 // | 229 // |
230 // May be returned in GetUpdatesMessage and sent up in CommitMessage. | 230 // May be returned in GetUpdatesMessage and sent up in CommitMessage. |
231 // | 231 // |
232 optional string client_defined_unique_tag = 23; | 232 optional string client_defined_unique_tag = 23; |
233 }; | 233 }; |
234 | 234 |
| 235 // This message contains diagnostic information used to correlate |
| 236 // commit-related traffic with extensions-related mutations to the |
| 237 // data models in chromium. It plays no functional role in |
| 238 // processing this CommitMessage. |
| 239 message ChromiumExtensionsActivity { |
| 240 // The human-readable ID identifying the extension responsible |
| 241 // for the traffic reported in this ChromiumExtensionsActivity. |
| 242 optional string extension_id = 1; |
| 243 |
| 244 // How many times the extension successfully invoked a write |
| 245 // operation through the bookmarks API since the last CommitMessage. |
| 246 optional uint32 bookmark_writes_since_last_commit = 2; |
| 247 }; |
| 248 |
235 message CommitMessage { | 249 message CommitMessage { |
236 repeated SyncEntity entries = 1; | 250 repeated SyncEntity entries = 1; |
237 | 251 |
238 // A GUID that identifies the committing sync client. This value will be | 252 // A GUID that identifies the committing sync client. This value will be |
239 // returned as originator_cache_guid for any new items. | 253 // returned as originator_cache_guid for any new items. |
240 optional string cache_guid = 2; | 254 optional string cache_guid = 2; |
241 | 255 |
242 // This message contains diagnostic information used to correlate | |
243 // commit-related traffic with extensions-related mutations to the | |
244 // data models in chromium. It plays no functional role in | |
245 // processing this CommitMessage. | |
246 message ChromiumExtensionsActivity { | |
247 // The human-readable ID identifying the extension responsible | |
248 // for the traffic reported in this ChromiumExtensionsActivity. | |
249 optional string extension_id = 1; | |
250 | |
251 // How many times the extension successfully invoked a write | |
252 // operation through the bookmarks API since the last CommitMessage. | |
253 optional uint32 bookmark_writes_since_last_commit = 2; | |
254 } | |
255 | |
256 repeated ChromiumExtensionsActivity extensions_activity = 3; | 256 repeated ChromiumExtensionsActivity extensions_activity = 3; |
257 }; | 257 }; |
258 | 258 |
259 message GetUpdatesCallerInfo { | 259 message GetUpdatesCallerInfo { |
260 enum GetUpdatesSource { | 260 enum GetUpdatesSource { |
261 UNKNOWN = 0; // The source was not set by the caller. | 261 UNKNOWN = 0; // The source was not set by the caller. |
262 FIRST_UPDATE = 1; // First update from an instance of Chrome. | 262 FIRST_UPDATE = 1; // First update from an instance of Chrome. |
263 LOCAL = 2; // The source of the update was a local change. | 263 LOCAL = 2; // The source of the update was a local change. |
264 NOTIFICATION = 3; // The source of the update was a p2p notification. | 264 NOTIFICATION = 3; // The source of the update was a p2p notification. |
265 PERIODIC = 4; // The source of the update was periodic polling. | 265 PERIODIC = 4; // The source of the update was periodic polling. |
(...skipping 20 matching lines...) Expand all Loading... |
286 // The presence of an individual EntitySpecifics extension indicates that the | 286 // The presence of an individual EntitySpecifics extension indicates that the |
287 // client requests sync object types associated with that extension. This | 287 // client requests sync object types associated with that extension. This |
288 // determination depends only on the presence of the extension field, not its | 288 // determination depends only on the presence of the extension field, not its |
289 // contents -- thus clients should send empty extension messages. For | 289 // contents -- thus clients should send empty extension messages. For |
290 // backwards compatibility only bookmark objects will be sent to the client | 290 // backwards compatibility only bookmark objects will be sent to the client |
291 // should requested_types not be present. | 291 // should requested_types not be present. |
292 // | 292 // |
293 // requested_types may contain multiple EntitySpecifics extensions -- in this | 293 // requested_types may contain multiple EntitySpecifics extensions -- in this |
294 // event, the server will return items of all the indicated types. | 294 // event, the server will return items of all the indicated types. |
295 optional EntitySpecifics requested_types = 4; | 295 optional EntitySpecifics requested_types = 4; |
| 296 |
| 297 // Client-requested limit on the maximum number of updates to return at once. |
| 298 // The server may opt to return fewer updates than this amount, but it should |
| 299 // not return more. |
| 300 optional int32 batch_size = 5; |
296 }; | 301 }; |
297 | 302 |
298 message AuthenticateMessage { | 303 message AuthenticateMessage { |
299 required string auth_token = 1; | 304 required string auth_token = 1; |
300 }; | 305 }; |
301 | 306 |
302 enum UserDataStatus { | 307 enum UserDataStatus { |
303 SUCCESS = 0; | 308 SUCCESS = 0; |
304 | 309 |
305 // A transient error happened, e.g. network error. Clear can be called again. | 310 // A transient error happened, e.g. network error. Clear can be called again. |
(...skipping 153 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
459 // is meaningless to this server. This happens most typically when | 464 // is meaningless to this server. This happens most typically when |
460 // you switch from one storage backend instance (say, a test instance) | 465 // you switch from one storage backend instance (say, a test instance) |
461 // to another (say, the official instance). | 466 // to another (say, the official instance). |
462 optional string store_birthday = 6; | 467 optional string store_birthday = 6; |
463 | 468 |
464 optional ClientCommand client_command = 7; | 469 optional ClientCommand client_command = 7; |
465 optional ProfilingData profiling_data = 8; | 470 optional ProfilingData profiling_data = 8; |
466 optional ClearUserDataResponse clear_user_data = 9; | 471 optional ClearUserDataResponse clear_user_data = 9; |
467 }; | 472 }; |
468 | 473 |
OLD | NEW |