| OLD | NEW |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 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 #ifndef SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_ | 5 #ifndef SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_ |
| 6 #define SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_ | 6 #define SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_ |
| 7 | 7 |
| 8 #include "base/basictypes.h" | 8 #include "base/basictypes.h" |
| 9 #include "base/memory/weak_ptr.h" | 9 #include "base/memory/weak_ptr.h" |
| 10 #include "base/sequenced_task_runner.h" | 10 #include "base/sequenced_task_runner.h" |
| 11 #include "sync/base/sync_export.h" | 11 #include "sync/base/sync_export.h" |
| 12 #include "sync/internal_api/public/base/model_type.h" | 12 #include "sync/internal_api/public/base/model_type.h" |
| 13 #include "sync/internal_api/public/non_blocking_sync_common.h" |
| 13 | 14 |
| 14 namespace syncer { | 15 namespace syncer { |
| 15 | 16 |
| 16 class ModelTypeSyncProxyImpl; | 17 class ModelTypeSyncProxyImpl; |
| 17 struct DataTypeState; | |
| 18 | 18 |
| 19 // An interface of the core parts of sync. | 19 // An interface of the core parts of sync. |
| 20 // | 20 // |
| 21 // In theory, this is the component that provides off-thread sync types with | 21 // In theory, this is the component that provides off-thread sync types with |
| 22 // functionality to schedule and execute communication with the sync server. In | 22 // functionality to schedule and execute communication with the sync server. In |
| 23 // practice, this class delegates most of the responsibilty of implemeting this | 23 // practice, this class delegates most of the responsibilty of implemeting this |
| 24 // functionality to other classes, and most of the interface is exposed not | 24 // functionality to other classes, and most of the interface is exposed not |
| 25 // directly here but instead through a per-ModelType class that this class helps | 25 // directly here but instead through a per-ModelType class that this class helps |
| 26 // instantiate. | 26 // instantiate. |
| 27 class SYNC_EXPORT_PRIVATE SyncContext { | 27 class SYNC_EXPORT_PRIVATE SyncContext { |
| 28 public: | 28 public: |
| 29 SyncContext(); | 29 SyncContext(); |
| 30 virtual ~SyncContext(); | 30 virtual ~SyncContext(); |
| 31 | 31 |
| 32 // Initializes the connection between the sync context on the sync thread and | 32 // Initializes the connection between the sync context on the sync thread and |
| 33 // a proxy for the specified non-blocking sync type that lives on the data | 33 // a proxy for the specified non-blocking sync type that lives on the data |
| 34 // type's thread. | 34 // type's thread. |
| 35 virtual void ConnectSyncTypeToWorker( | 35 virtual void ConnectSyncTypeToWorker( |
| 36 syncer::ModelType type, | 36 syncer::ModelType type, |
| 37 const DataTypeState& data_type_state, | 37 const DataTypeState& data_type_state, |
| 38 const syncer::UpdateResponseDataList& saved_pending_updates, |
| 38 const scoped_refptr<base::SequencedTaskRunner>& datatype_task_runner, | 39 const scoped_refptr<base::SequencedTaskRunner>& datatype_task_runner, |
| 39 const base::WeakPtr<ModelTypeSyncProxyImpl>& type_sync_proxy) = 0; | 40 const base::WeakPtr<ModelTypeSyncProxyImpl>& type_sync_proxy) = 0; |
| 40 | 41 |
| 41 // Disconnects the syncer from the model and stops syncing the type. | 42 // Disconnects the syncer from the model and stops syncing the type. |
| 42 // | 43 // |
| 43 // By the time this is called, the model thread should have already | 44 // By the time this is called, the model thread should have already |
| 44 // invalidated the WeakPtr it sent to us in the connect request. Any | 45 // invalidated the WeakPtr it sent to us in the connect request. Any |
| 45 // messages sent to that ModelTypeSyncProxy will not be recived. | 46 // messages sent to that ModelTypeSyncProxy will not be recived. |
| 46 // | 47 // |
| 47 // This is the sync thread's chance to clear state associated with the type. | 48 // This is the sync thread's chance to clear state associated with the type. |
| 48 // It also causes the syncer to stop requesting updates for this type, and to | 49 // It also causes the syncer to stop requesting updates for this type, and to |
| 49 // abort any in-progress commit requests. | 50 // abort any in-progress commit requests. |
| 50 virtual void DisconnectSyncWorker(ModelType type) = 0; | 51 virtual void DisconnectSyncWorker(ModelType type) = 0; |
| 51 }; | 52 }; |
| 52 | 53 |
| 53 } // namespace syncer | 54 } // namespace syncer |
| 54 | 55 |
| 55 #endif // SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_ | 56 #endif // SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_ |
| OLD | NEW |