model_type_controller.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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. #ifndef COMPONENTS_SYNC_DRIVER_MODEL_TYPE_CONTROLLER_H_
  5. #define COMPONENTS_SYNC_DRIVER_MODEL_TYPE_CONTROLLER_H_
  6. #include <memory>
  7. #include <vector>
  8. #include "base/callback.h"
  9. #include "base/containers/flat_map.h"
  10. #include "base/memory/raw_ptr.h"
  11. #include "base/memory/weak_ptr.h"
  12. #include "components/sync/base/model_type.h"
  13. #include "components/sync/base/sync_mode.h"
  14. #include "components/sync/driver/configure_context.h"
  15. #include "components/sync/driver/data_type_controller.h"
  16. #include "components/sync/model/model_error.h"
  17. #include "components/sync/model/model_type_controller_delegate.h"
  18. #include "components/sync/model/sync_error.h"
  19. namespace syncer {
  20. struct DataTypeActivationResponse;
  21. // DataTypeController implementation for Unified Sync and Storage model types.
  22. class ModelTypeController : public DataTypeController {
  23. public:
  24. // For datatypes that do not run in transport-only mode.
  25. ModelTypeController(
  26. ModelType type,
  27. std::unique_ptr<ModelTypeControllerDelegate> delegate_for_full_sync_mode);
  28. // For datatypes that have support for STORAGE_IN_MEMORY.
  29. ModelTypeController(
  30. ModelType type,
  31. std::unique_ptr<ModelTypeControllerDelegate> delegate_for_full_sync_mode,
  32. std::unique_ptr<ModelTypeControllerDelegate> delegate_for_transport_mode);
  33. ModelTypeController(const ModelTypeController&) = delete;
  34. ModelTypeController& operator=(const ModelTypeController&) = delete;
  35. ~ModelTypeController() override;
  36. // DataTypeController implementation.
  37. void LoadModels(const ConfigureContext& configure_context,
  38. const ModelLoadCallback& model_load_callback) override;
  39. std::unique_ptr<DataTypeActivationResponse> Connect() override;
  40. void Stop(ShutdownReason reason, StopCallback callback) override;
  41. State state() const override;
  42. bool ShouldRunInTransportOnlyMode() const override;
  43. void GetAllNodes(AllNodesCallback callback) override;
  44. void GetTypeEntitiesCount(base::OnceCallback<void(const TypeEntitiesCount&)>
  45. callback) const override;
  46. void RecordMemoryUsageAndCountsHistograms() override;
  47. ModelTypeControllerDelegate* GetDelegateForTesting(SyncMode sync_mode);
  48. protected:
  49. // Subclasses that use this constructor must call InitModelTypeController().
  50. explicit ModelTypeController(ModelType type);
  51. // |delegate_for_transport_mode| may be null if the type does not run in
  52. // transport mode.
  53. void InitModelTypeController(
  54. std::unique_ptr<ModelTypeControllerDelegate> delegate_for_full_sync_mode,
  55. std::unique_ptr<ModelTypeControllerDelegate> delegate_for_transport_mode);
  56. void ReportModelError(SyncError::ErrorType error_type,
  57. const ModelError& error);
  58. private:
  59. void RecordStartFailure() const;
  60. void RecordRunFailure() const;
  61. void OnDelegateStarted(
  62. std::unique_ptr<DataTypeActivationResponse> activation_response);
  63. void TriggerCompletionCallbacks(const SyncError& error);
  64. base::flat_map<SyncMode, std::unique_ptr<ModelTypeControllerDelegate>>
  65. delegate_map_;
  66. // State of this datatype controller.
  67. State state_ = NOT_RUNNING;
  68. // Owned by |delegate_map_|. Null while NOT_RUNNING.
  69. raw_ptr<ModelTypeControllerDelegate> delegate_ = nullptr;
  70. // Callback for use when starting the datatype (usually MODEL_STARTING, but
  71. // STOPPING if abort requested while starting).
  72. ModelLoadCallback model_load_callback_;
  73. // Callbacks for use when stopping the datatype (STOPPING), which also
  74. // includes aborting a start. This is important because STOPPING is a state
  75. // used to make sure we don't request two starts in parallel to the delegate,
  76. // which is hard to support, most notably in ClientTagBasedModelTypeProcessor.
  77. // We use a vector because it's allowed to call Stop() multiple times (i.e.
  78. // while STOPPING).
  79. std::vector<StopCallback> model_stop_callbacks_;
  80. SyncStopMetadataFate model_stop_metadata_fate_;
  81. // Controller receives |activation_response_| from
  82. // ClientTagBasedModelTypeProcessor callback and must temporarily own it until
  83. // Connect is called.
  84. std::unique_ptr<DataTypeActivationResponse> activation_response_;
  85. };
  86. } // namespace syncer
  87. #endif // COMPONENTS_SYNC_DRIVER_MODEL_TYPE_CONTROLLER_H_