blob: 13e051b10a1531d43761c153e3ad358fa749f32b [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 <map>
#include <vector>
#include "base/macros.h"
#include "sync/base/sync_export.h"
#include "sync/engine/commit.h"
#include "sync/internal_api/public/base/model_type.h"
#include "sync/internal_api/public/engine/model_safe_worker.h"
#include "sync/sessions/model_type_registry.h"
namespace syncer {
namespace syncable {
class Directory;
} // namespace syncable
class CommitContributor;
class CommitContribution;
// This class manages the set of per-type committer objects.
// It owns these types and hides the details of iterating over all of them.
// Many 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.
class SYNC_EXPORT CommitProcessor {
// Contructs a CommitProcessor from a map of CommitContributors.
// The CommitProcessor does not own this map.
explicit CommitProcessor(CommitContributorMap* commit_contributor_map);
// Gathers a set of contributions to be used to populate a commit message.
// For each of the |commit_types| in this CommitProcessor's CommitContributor
// map, gather any entries queued for commit into CommitContributions. The
// total number of entries in all the returned CommitContributions shall not
// exceed |max_entries|.
// Note: |cookie_jar_mismatch| and |cookie_jar_empty| are used only for
// metrics recording purposes specific to the SESSIONS type.
void GatherCommitContributions(ModelTypeSet commit_types,
size_t max_entries,
bool cookie_jar_mismatch,
bool cookie_jar_empty,
Commit::ContributionMap* contributions);
// A map of 'commit contributors', one for each enabled type.
CommitContributorMap* commit_contributor_map_;
} // namespace syncer