blob: 74ea40c82767c50fabf9b6a3638bd1d272d0f860 [file] [log] [blame]
// 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.
#include <stddef.h>
#include <stdint.h>
#include <vector>
#include "base/macros.h"
#include "components/sync/base/passphrase_enums.h"
#include "components/sync/engine/non_blocking_sync_common.h"
#include "components/sync/engine_impl/commit_contribution.h"
#include "components/sync/engine_impl/cycle/data_type_debug_info_emitter.h"
#include "components/sync/protocol/sync.pb.h"
namespace syncer {
class Cryptographer;
class ModelTypeWorker;
// A non-blocking sync type's contribution to an outgoing commit message.
// Helps build a commit message and process its response. It collaborates
// closely with the ModelTypeWorker.
class NonBlockingTypeCommitContribution : public CommitContribution {
ModelType type,
const sync_pb::DataTypeContext& context,
const CommitRequestDataList& commit_requests,
ModelTypeWorker* worker,
Cryptographer* cryptographer,
PassphraseType passphrase_type,
DataTypeDebugInfoEmitter* debug_info_emitter,
bool only_commit_specifics);
~NonBlockingTypeCommitContribution() override;
// Implementation of CommitContribution
void AddToCommitMessage(sync_pb::ClientToServerMessage* msg) override;
SyncerError ProcessCommitResponse(
const sync_pb::ClientToServerResponse& response,
StatusController* status) override;
void CleanUp() override;
size_t GetNumEntries() const override;
// Public for testing.
// Copies data to be committed from CommitRequestData into SyncEntity proto.
static void PopulateCommitProto(const CommitRequestData& commit_entity,
sync_pb::SyncEntity* commit_proto);
// Generates id for new entities and encrypts entity if needed.
void AdjustCommitProto(sync_pb::SyncEntity* commit_proto);
const ModelType type_;
// A non-owned pointer back to the object that created this contribution.
ModelTypeWorker* const worker_;
// A non-owned pointer to cryptographer to encrypt entities.
Cryptographer* const cryptographer_;
const PassphraseType passphrase_type_;
// The type-global context information.
const sync_pb::DataTypeContext context_;
// The list of entities to be committed.
CommitRequestDataList commit_requests_;
// The index in the commit message where this contribution's entities are
// added. Used to correlate per-item requests with per-item responses.
size_t entries_start_index_;
// A flag used to ensure this object's contract is respected. Helps to check
// that CleanUp() is called before the object is destructed.
bool cleaned_up_;
DataTypeDebugInfoEmitter* debug_info_emitter_;
// Don't send any metadata to server, only specifics. This is needed for
// commit only types to save bandwidth.
bool only_commit_specifics_;
} // namespace syncer