• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.
4 
5 #ifndef SYNC_INTERNAL_API_PUBLIC_SYNC_CORE_H_
6 #define SYNC_INTERNAL_API_PUBLIC_SYNC_CORE_H_
7 
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 
14 namespace syncer {
15 
16 class ModelTypeRegistry;
17 class NonBlockingTypeProcessor;
18 struct DataTypeState;
19 
20 // An interface of the core parts of sync.
21 //
22 // In theory, this is the component that provides off-thread sync types with
23 // functionality to schedule and execute communication with the sync server.  In
24 // practice, this class delegates most of the responsibilty of implemeting this
25 // functionality to other classes, and most of the interface is exposed not
26 // directly here but instead through a per-ModelType class that this class helps
27 // instantiate.
28 class SYNC_EXPORT_PRIVATE SyncCore {
29  public:
30   explicit SyncCore(ModelTypeRegistry* model_type_registry);
31   ~SyncCore();
32 
33   // Initializes the connection between the sync core and its delegate on the
34   // sync client's thread.
35   void ConnectSyncTypeToCore(
36       syncer::ModelType type,
37       const DataTypeState& data_type_state,
38       scoped_refptr<base::SequencedTaskRunner> datatype_task_runner,
39       base::WeakPtr<NonBlockingTypeProcessor> sync_client);
40 
41   // Disconnects the syncer from the model and stops syncing the type.
42   //
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 NonBlockingTypeProcessor will not be recived.
46   //
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   void Disconnect(ModelType type);
51 
52   base::WeakPtr<SyncCore> AsWeakPtr();
53 
54  private:
55   ModelTypeRegistry* model_type_registry_;
56   base::WeakPtrFactory<SyncCore> weak_ptr_factory_;
57 
58   DISALLOW_COPY_AND_ASSIGN(SyncCore);
59 };
60 
61 }  // namespace syncer
62 
63 #endif  // SYNC_INTERNAL_API_PUBLIC_SYNC_CORE_H_
64 
65