| // Copyright 2014 The Chromium Authors | |
| // Use of this source code is governed by a BSD-style license that can be | |
| // found in the LICENSE file. | |
| #ifndef COMPONENTS_SYNC_ENGINE_GET_UPDATES_PROCESSOR_H_ | |
| #define COMPONENTS_SYNC_ENGINE_GET_UPDATES_PROCESSOR_H_ | |
| #include "base/gtest_prod_util.h" | |
| #include "base/memory/raw_ptr.h" | |
| #include "components/sync/base/model_type.h" | |
| #include "components/sync/base/syncer_error.h" | |
| #include "components/sync/engine/model_type_registry.h" | |
| namespace sync_pb { | |
| class GetUpdatesResponse; | |
| class ClientToServerMessage; | |
| } // namespace sync_pb | |
| namespace syncer { | |
| class GetUpdatesDelegate; | |
| class StatusController; | |
| class SyncCycle; | |
| // This class manages the set of per-type syncer objects. | |
| // | |
| // It owns these types and hides the details of iterating over all of them. | |
| // Most methods allow the caller to specify a subset of types on which the | |
| // operation is to be applied. It is a logic error if the supplied set of types | |
| // contains a type which was not previously registered with the manager. | |
| class GetUpdatesProcessor { | |
| public: | |
| explicit GetUpdatesProcessor(UpdateHandlerMap* update_handler_map, | |
| const GetUpdatesDelegate& delegate); | |
| GetUpdatesProcessor(const GetUpdatesProcessor&) = delete; | |
| GetUpdatesProcessor& operator=(const GetUpdatesProcessor&) = delete; | |
| ~GetUpdatesProcessor(); | |
| // Downloads and processes a batch of updates for the specified types. | |
| // | |
| // Returns SYNCER_OK if the download succeeds, SERVER_MORE_TO_DOWNLOAD if the | |
| // download succeeded but there are still some updates left to fetch on the | |
| // server, or an appropriate error value in case of failure. | |
| SyncerError DownloadUpdates(ModelTypeSet* request_types, SyncCycle* cycle); | |
| // Applies any downloaded and processed updates. | |
| void ApplyUpdates(const ModelTypeSet& gu_types, | |
| StatusController* status_controller); | |
| private: | |
| // Populates a GetUpdates request message with per-type information. | |
| void PrepareGetUpdates(const ModelTypeSet& gu_types, | |
| sync_pb::ClientToServerMessage* message); | |
| // Sends the specified message to the server and stores the response in a | |
| // member of the |cycle|'s StatusController. | |
| SyncerError ExecuteDownloadUpdates(ModelTypeSet* request_types, | |
| SyncCycle* cycle, | |
| sync_pb::ClientToServerMessage* msg); | |
| // Processes a GetUpdates response for each type. | |
| SyncerError ProcessResponse(const sync_pb::GetUpdatesResponse& gu_response, | |
| const ModelTypeSet& gu_types, | |
| StatusController* status_controller); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, BookmarkNudge); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, NotifyMany); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, InitialSyncRequest); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, ConfigureTest); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, PollTest); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, RetryTest); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, NudgeWithRetryTest); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, InvalidResponse); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, MoreToDownloadResponse); | |
| FRIEND_TEST_ALL_PREFIXES(GetUpdatesProcessorTest, NormalResponseTest); | |
| FRIEND_TEST_ALL_PREFIXES(DownloadUpdatesDebugInfoTest, | |
| VerifyCopyClientDebugInfo_Empty); | |
| FRIEND_TEST_ALL_PREFIXES(DownloadUpdatesDebugInfoTest, VerifyCopyOverwrites); | |
| // A map of 'update handlers', one for each enabled type. | |
| // This must be kept in sync with the routing info. Our temporary solution to | |
| // that problem is to initialize this map in set_routing_info(). | |
| raw_ptr<UpdateHandlerMap> update_handler_map_; | |
| const GetUpdatesDelegate& delegate_; | |
| }; | |
| } // namespace syncer | |
| #endif // COMPONENTS_SYNC_ENGINE_GET_UPDATES_PROCESSOR_H_ |