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 "sync/internal_api/public/util/syncer_error.h"
   9
  10 namespace syncer {
  11
  12 namespace sessions {
  13 class SyncSession;
  14 }
  15
  16 class Syncer;
  17
  18 // This function will commit batches of unsynced items to the server until the
  19 // number of unsynced and ready to commit items reaches zero or an error is
  20 // encountered.  A request to exit early will be treated as an error and will
  21 // abort any blocking operations.
  22 //
  23 // The Syncer parameter is provided only for access to its ExitRequested()
  24 // method.  This is technically unnecessary since an early exit request should
  25 // be detected as we attempt to contact the sync server.
  26 //
  27 // The SyncSession parameter contains pointers to various bits of state,
  28 // including the syncable::Directory that contains all sync items and the
  29 // ServerConnectionManager used to contact the server.
  30 SyncerError BuildAndPostCommits(
  31     Syncer* syncer,
  32     sessions::SyncSession* session);
  33
  34 }  // namespace syncer
  35
  36 #endif  // SYNC_ENGINE_COMMIT_H_