sync/engine/commit.h

   1 // Copyright (c) 2012 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
   5 #ifndef SYNC_ENGINE_COMMIT_H_
   6 #define SYNC_ENGINE_COMMIT_H_
   7
   8 #include "base/containers/scoped_ptr_map.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "sync/base/sync_export.h"
  11 #include "sync/engine/commit_contribution.h"
  12 #include "sync/internal_api/public/base/model_type.h"
  13 #include "sync/internal_api/public/engine/model_safe_worker.h"
  14 #include "sync/internal_api/public/util/syncer_error.h"
  15 #include "sync/protocol/sync.pb.h"
  16 #include "sync/sessions/nudge_tracker.h"
  17 #include "sync/util/extensions_activity.h"
  18
  19 namespace syncer {
  20
  21 namespace sessions {
  22 class StatusController;
  23 class SyncSession;
  24 }
  25
  26 class CommitProcessor;
  27 class Syncer;
  28
  29 // This class wraps the actions related to building and executing a single
  30 // commit operation.
  31 //
  32 // This class' most important responsibility is to manage the ContributionsMap.
  33 // This class serves as a container for those objects.  Although it would have
  34 // been acceptable to let this class be a dumb container object, it turns out
  35 // that there was no other convenient place to put the Init() and
  36 // PostAndProcessCommitResponse() functions.  So they ended up here.
  37 class SYNC_EXPORT_PRIVATE Commit {
  38  public:
  39   typedef base::ScopedPtrMap<ModelType, scoped_ptr<CommitContribution>>
  40       ContributionMap;
  41
  42   Commit(ContributionMap contributions,
  43          const sync_pb::ClientToServerMessage& message,
  44          ExtensionsActivity::Records extensions_activity_buffer);
  45
  46   // This destructor will DCHECK if CleanUp() has not been called.
  47   ~Commit();
  48
  49   static Commit* Init(
  50       ModelTypeSet requested_types,
  51       ModelTypeSet enabled_types,
  52       size_t max_entries,
  53       const std::string& account_name,
  54       const std::string& cache_guid,
  55       CommitProcessor* commit_processor,
  56       ExtensionsActivity* extensions_activity);
  57
  58   SyncerError PostAndProcessResponse(sessions::NudgeTracker* nudge_tracker,
  59                                      sessions::SyncSession* session,
  60                                      sessions::StatusController* status,
  61                                      ExtensionsActivity* extensions_activity);
  62
  63   // Cleans up state associated with this commit.  Must be called before the
  64   // destructor.
  65   void CleanUp();
  66
  67  private:
  68   ContributionMap contributions_;
  69
  70   sync_pb::ClientToServerMessage message_;
  71   sync_pb::ClientToServerResponse response_;
  72   ExtensionsActivity::Records extensions_activity_buffer_;
  73
  74   // Debug only flag used to indicate if it's safe to destruct the object.
  75   bool cleaned_up_;
  76 };
  77
  78 }  // namespace syncer
  79
  80 #endif  // SYNC_ENGINE_COMMIT_H_