OLD | NEW |
1 // Copyright (c) 2010 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2010 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 // A class representing an attempt to synchronize the local syncable data | 5 // A class representing an attempt to synchronize the local syncable data |
6 // store with a sync server. A SyncSession instance is passed as a stateful | 6 // store with a sync server. A SyncSession instance is passed as a stateful |
7 // bundle to and from various SyncerCommands with the goal of converging the | 7 // bundle to and from various SyncerCommands with the goal of converging the |
8 // client view of data with that of the server. The commands twiddle with | 8 // client view of data with that of the server. The commands twiddle with |
9 // session status in response to events and hiccups along the way, set and | 9 // session status in response to events and hiccups along the way, set and |
10 // query session progress with regards to conflict resolution and applying | 10 // query session progress with regards to conflict resolution and applying |
11 // server updates, and access the SyncSessionContext for the current session | 11 // server updates, and access the SyncSessionContext for the current session |
12 // via SyncSession instances. | 12 // via SyncSession instances. |
13 | 13 |
14 #ifndef CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_ | 14 #ifndef CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_ |
15 #define CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_ | 15 #define CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_ |
16 #pragma once | 16 #pragma once |
17 | 17 |
| 18 #include <map> |
| 19 #include <string> |
18 #include <utility> | 20 #include <utility> |
19 #include <vector> | 21 #include <vector> |
20 | 22 |
21 #include "base/basictypes.h" | 23 #include "base/basictypes.h" |
22 #include "base/scoped_ptr.h" | 24 #include "base/scoped_ptr.h" |
23 #include "base/time.h" | 25 #include "base/time.h" |
| 26 #include "chrome/browser/sync/engine/model_safe_worker.h" |
24 #include "chrome/browser/sync/sessions/ordered_commit_set.h" | 27 #include "chrome/browser/sync/sessions/ordered_commit_set.h" |
25 #include "chrome/browser/sync/sessions/session_state.h" | 28 #include "chrome/browser/sync/sessions/session_state.h" |
26 #include "chrome/browser/sync/sessions/status_controller.h" | 29 #include "chrome/browser/sync/sessions/status_controller.h" |
27 #include "chrome/browser/sync/sessions/sync_session_context.h" | 30 #include "chrome/browser/sync/sessions/sync_session_context.h" |
| 31 #include "chrome/browser/sync/syncable/model_type.h" |
28 #include "chrome/browser/sync/util/extensions_activity_monitor.h" | 32 #include "chrome/browser/sync/util/extensions_activity_monitor.h" |
29 | 33 |
30 namespace syncable { | 34 namespace syncable { |
31 class WriteTransaction; | 35 class WriteTransaction; |
32 } | 36 } |
33 | 37 |
34 namespace browser_sync { | 38 namespace browser_sync { |
35 class ModelSafeWorker; | 39 class ModelSafeWorker; |
36 | 40 |
37 namespace sessions { | 41 namespace sessions { |
38 typedef std::pair<sync_pb::GetUpdatesCallerInfo::GetUpdatesSource, | 42 |
39 syncable::ModelTypeBitSet> SyncSourceInfo; | 43 // A container that contains a set of datatypes with possible string payloads. |
| 44 typedef std::map<syncable::ModelType, std::string> TypePayloadMap; |
| 45 |
| 46 // Helper utils for building TypePayloadMaps. |
| 47 // Convert a ModelTypeBitset into a TypePayloadMap using a default payload. |
| 48 TypePayloadMap ModelTypeBitSetToTypePayloadMap( |
| 49 const syncable::ModelTypeBitSet& types, |
| 50 const std::string& payload); |
| 51 // Convert a ModelSafeRoutingInfo into a TypePayloadMap using a default payload. |
| 52 TypePayloadMap RoutingInfoToTypePayloadMap( |
| 53 const ModelSafeRoutingInfo& routes, |
| 54 const std::string& payload); |
| 55 // Coalesce |update| into |original|, overwriting only when |update| has |
| 56 // a non-empty payload. |
| 57 void CoalescePayloads(TypePayloadMap* original, const TypePayloadMap& update); |
| 58 |
| 59 // A container for the source of a sync session. This includes the update |
| 60 // source, the datatypes triggering the sync session, and possible session |
| 61 // specific payloads which should be sent to the server. |
| 62 struct SyncSourceInfo { |
| 63 SyncSourceInfo(); |
| 64 SyncSourceInfo( |
| 65 const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& u, |
| 66 const TypePayloadMap& t); |
| 67 |
| 68 sync_pb::GetUpdatesCallerInfo::GetUpdatesSource updates_source; |
| 69 TypePayloadMap types; |
| 70 }; |
40 | 71 |
41 class SyncSession { | 72 class SyncSession { |
42 public: | 73 public: |
43 // The Delegate services events that occur during the session requiring an | 74 // The Delegate services events that occur during the session requiring an |
44 // explicit (and session-global) action, as opposed to events that are simply | 75 // explicit (and session-global) action, as opposed to events that are simply |
45 // recorded in per-session state. | 76 // recorded in per-session state. |
46 class Delegate { | 77 class Delegate { |
47 public: | 78 public: |
48 // The client was throttled and should cease-and-desist syncing activity | 79 // The client was throttled and should cease-and-desist syncing activity |
49 // until the specified time. | 80 // until the specified time. |
(...skipping 113 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
163 | 194 |
164 private: | 195 private: |
165 SyncSession* session_; | 196 SyncSession* session_; |
166 DISALLOW_COPY_AND_ASSIGN(ScopedSetSessionWriteTransaction); | 197 DISALLOW_COPY_AND_ASSIGN(ScopedSetSessionWriteTransaction); |
167 }; | 198 }; |
168 | 199 |
169 } // namespace sessions | 200 } // namespace sessions |
170 } // namespace browser_sync | 201 } // namespace browser_sync |
171 | 202 |
172 #endif // CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_ | 203 #endif // CHROME_BROWSER_SYNC_SESSIONS_SYNC_SESSION_H_ |
OLD | NEW |