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
3 // found in the LICENSE file.
5 #ifndef SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_
6 #define SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_
8 #include "base/basictypes.h"
9 #include "base/memory/weak_ptr.h"
10 #include "base/sequenced_task_runner.h"
11 #include "sync/base/sync_export.h"
12 #include "sync/internal_api/public/base/model_type.h"
13 #include "sync/internal_api/public/non_blocking_sync_common.h"
16 class ModelTypeProcessor
;
18 // An interface of the core parts of sync.
20 // In theory, this is the component that provides off-thread sync types with
21 // functionality to schedule and execute communication with the sync server. In
22 // practice, this class delegates most of the responsibilty of implemeting this
23 // functionality to other classes, and most of the interface is exposed not
24 // directly here but instead through a per-ModelType class that this class helps
26 class SYNC_EXPORT_PRIVATE SyncContext
{
29 virtual ~SyncContext();
31 // Initializes the connection between the sync context on the sync thread and
32 // a proxy for the specified non-blocking sync type that lives on the data
34 virtual void ConnectSyncTypeToWorker(
35 syncer::ModelType type
,
36 const DataTypeState
& data_type_state
,
37 const UpdateResponseDataList
& saved_pending_updates
,
38 const scoped_refptr
<base::SequencedTaskRunner
>& datatype_task_runner
,
39 const base::WeakPtr
<ModelTypeProcessor
>& type_processor
) = 0;
41 // Disconnects the syncer from the model and stops syncing the type.
43 // 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 // messages sent to that ModelTypeProcessor will not be recived.
47 // 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 // abort any in-progress commit requests.
50 virtual void DisconnectSyncWorker(syncer::ModelType type
) = 0;
55 #endif // SYNC_INTERNAL_API_PUBLIC_SYNC_CONTEXT_H_