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 <string> |
18 #include <utility> | 19 #include <utility> |
19 #include <vector> | 20 #include <vector> |
20 | 21 |
21 #include "base/basictypes.h" | 22 #include "base/basictypes.h" |
22 #include "base/scoped_ptr.h" | 23 #include "base/scoped_ptr.h" |
23 #include "base/time.h" | 24 #include "base/time.h" |
24 #include "chrome/browser/sync/sessions/ordered_commit_set.h" | 25 #include "chrome/browser/sync/sessions/ordered_commit_set.h" |
25 #include "chrome/browser/sync/sessions/session_state.h" | 26 #include "chrome/browser/sync/sessions/session_state.h" |
26 #include "chrome/browser/sync/sessions/status_controller.h" | 27 #include "chrome/browser/sync/sessions/status_controller.h" |
27 #include "chrome/browser/sync/sessions/sync_session_context.h" | 28 #include "chrome/browser/sync/sessions/sync_session_context.h" |
28 #include "chrome/browser/sync/util/extensions_activity_monitor.h" | 29 #include "chrome/browser/sync/util/extensions_activity_monitor.h" |
29 | 30 |
30 namespace syncable { | 31 namespace syncable { |
31 class WriteTransaction; | 32 class WriteTransaction; |
32 } | 33 } |
33 | 34 |
34 namespace browser_sync { | 35 namespace browser_sync { |
35 class ModelSafeWorker; | 36 class ModelSafeWorker; |
36 | 37 |
37 namespace sessions { | 38 namespace sessions { |
38 typedef std::pair<sync_pb::GetUpdatesCallerInfo::GetUpdatesSource, | 39 // A container for the source of a sync session. This includes the update |
39 syncable::ModelTypeBitSet> SyncSourceInfo; | 40 // source, the datatypes triggering the sync session, and possible session |
| 41 // specific payloads which should be sent to the server. |
| 42 class SyncSourceInfo { |
| 43 public: |
| 44 SyncSourceInfo() {} |
| 45 SyncSourceInfo( |
| 46 const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& updates_source, |
| 47 const syncable::ModelTypeBitSet& types) |
| 48 : updates_source_(updates_source), types_(types) {} |
| 49 SyncSourceInfo( |
| 50 const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& updates_source, |
| 51 const syncable::ModelTypeBitSet& types, |
| 52 const std::vector<std::string>& payloads) |
| 53 : updates_source_(updates_source), types_(types), payloads_(payloads) {} |
| 54 |
| 55 inline const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource& updates_source() |
| 56 const { |
| 57 return updates_source_; |
| 58 } |
| 59 inline const syncable::ModelTypeBitSet& types() const { |
| 60 return types_; |
| 61 } |
| 62 inline const std::vector<std::string>& payloads() const { |
| 63 return payloads_; |
| 64 } |
| 65 |
| 66 private: |
| 67 sync_pb::GetUpdatesCallerInfo::GetUpdatesSource updates_source_; |
| 68 syncable::ModelTypeBitSet types_; |
| 69 std::vector<std::string> payloads_; |
| 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 |