1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_SYNC_ENGINE_IMPL_GET_UPDATES_DELEGATE_H_
#define COMPONENTS_SYNC_ENGINE_IMPL_GET_UPDATES_DELEGATE_H_
#include <memory>
#include "base/macros.h"
#include "components/sync/engine/events/protocol_event.h"
#include "components/sync/engine_impl/cycle/nudge_tracker.h"
#include "components/sync/engine_impl/cycle/status_controller.h"
#include "components/sync/engine_impl/model_type_registry.h"
#include "components/sync/protocol/sync.pb.h"
namespace syncer {
class GetUpdatesProcessor;
// Interface for GetUpdates functionality that dependends on the requested
// GetUpdate type (normal, configuration, poll). The GetUpdatesProcessor is
// given an appropriate GetUpdatesDelegate to handle type specific functionality
// on construction.
class GetUpdatesDelegate {
public:
GetUpdatesDelegate();
virtual ~GetUpdatesDelegate() = 0;
// Populates GetUpdate message fields that depende on GetUpdates request type.
virtual void HelpPopulateGuMessage(
sync_pb::GetUpdatesMessage* get_updates) const = 0;
// Applies pending updates to non-control types.
virtual void ApplyUpdates(ModelTypeSet gu_types,
StatusController* status,
UpdateHandlerMap* update_handler_map) const = 0;
virtual std::unique_ptr<ProtocolEvent> GetNetworkRequestEvent(
base::Time timestamp,
const sync_pb::ClientToServerMessage& request) const = 0;
};
// Functionality specific to the normal GetUpdate request.
class NormalGetUpdatesDelegate : public GetUpdatesDelegate {
public:
explicit NormalGetUpdatesDelegate(const NudgeTracker& nudge_tracker);
~NormalGetUpdatesDelegate() override;
// Uses the member NudgeTracker to populate some fields of this GU message.
void HelpPopulateGuMessage(
sync_pb::GetUpdatesMessage* get_updates) const override;
// Applies pending updates on the appropriate data type threads.
void ApplyUpdates(ModelTypeSet gu_types,
StatusController* status,
UpdateHandlerMap* update_handler_map) const override;
std::unique_ptr<ProtocolEvent> GetNetworkRequestEvent(
base::Time timestamp,
const sync_pb::ClientToServerMessage& request) const override;
private:
const NudgeTracker& nudge_tracker_;
DISALLOW_COPY_AND_ASSIGN(NormalGetUpdatesDelegate);
};
// Functionality specific to the configure GetUpdate request.
class ConfigureGetUpdatesDelegate : public GetUpdatesDelegate {
public:
ConfigureGetUpdatesDelegate(
sync_pb::GetUpdatesCallerInfo::GetUpdatesSource source);
~ConfigureGetUpdatesDelegate() override;
// Sets the 'source' and 'origin' fields for this request.
void HelpPopulateGuMessage(
sync_pb::GetUpdatesMessage* get_updates) const override;
// Applies updates passively (ie. on the sync thread).
//
// This is safe only if the ChangeProcessor is not listening to changes at
// this time.
void ApplyUpdates(ModelTypeSet gu_types,
StatusController* status,
UpdateHandlerMap* update_handler_map) const override;
std::unique_ptr<ProtocolEvent> GetNetworkRequestEvent(
base::Time timestamp,
const sync_pb::ClientToServerMessage& request) const override;
private:
static sync_pb::SyncEnums::GetUpdatesOrigin ConvertConfigureSourceToOrigin(
sync_pb::GetUpdatesCallerInfo::GetUpdatesSource source);
const sync_pb::GetUpdatesCallerInfo::GetUpdatesSource source_;
DISALLOW_COPY_AND_ASSIGN(ConfigureGetUpdatesDelegate);
};
// Functionality specific to the poll GetUpdate request.
class PollGetUpdatesDelegate : public GetUpdatesDelegate {
public:
PollGetUpdatesDelegate();
~PollGetUpdatesDelegate() override;
// Sets the 'source' and 'origin' to indicate this is a poll request.
void HelpPopulateGuMessage(
sync_pb::GetUpdatesMessage* get_updates) const override;
// Applies updates on the appropriate data type thread.
void ApplyUpdates(ModelTypeSet gu_types,
StatusController* status,
UpdateHandlerMap* update_handler_map) const override;
std::unique_ptr<ProtocolEvent> GetNetworkRequestEvent(
base::Time timestamp,
const sync_pb::ClientToServerMessage& request) const override;
private:
DISALLOW_COPY_AND_ASSIGN(PollGetUpdatesDelegate);
};
} // namespace syncer
#endif // COMPONENTS_SYNC_ENGINE_IMPL_GET_UPDATES_DELEGATE_H_
|