ios/chrome/browser/sync/glue/sync_start_util.h

   1 // Copyright 2015 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 IOS_CHROME_BROWSER_SYNC_GLUE_SYNC_START_UTIL_H_
   6 #define IOS_CHROME_BROWSER_SYNC_GLUE_SYNC_START_UTIL_H_
   7
   8 #include "sync/api/syncable_service.h"
   9
  10 namespace base {
  11 class FilePath;
  12 }
  13
  14 // Various utilities for kicking off sync initialization from data types or
  15 // other services.
  16 namespace ios {
  17 namespace sync_start_util {
  18
  19 // Creates a StartSyncFlare that a SyncableService can use to tell
  20 // sync_driver::SyncService it needs sync to start ASAP.  Typically this would
  21 // be given to the SyncableService on construction.
  22 //
  23 // The flare built by this function is designed to be Run()able from any thread
  24 // so that non-UI types don't have to deal with posting tasks.
  25 //
  26 // |browser_state_path| is used to get a hold of the actual ChromeBrowserState*
  27 // once the request to start sync is safely in UI Thread land.
  28 syncer::SyncableService::StartSyncFlare GetFlareForSyncableService(
  29     const base::FilePath& browser_state_path);
  30
  31 }  // namespace sync_start_util
  32 }  // namespace ios
  33
  34 #endif  // IOS_CHROME_BROWSER_SYNC_GLUE_SYNC_START_UTIL_H_