| OLD | NEW |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef COMPONENTS_SYNC_DRIVER_LOCAL_DEVICE_INFO_PROVIDER_H_ | 5 #ifndef COMPONENTS_SYNC_DRIVER_LOCAL_DEVICE_INFO_PROVIDER_H_ |
| 6 #define COMPONENTS_SYNC_DRIVER_LOCAL_DEVICE_INFO_PROVIDER_H_ | 6 #define COMPONENTS_SYNC_DRIVER_LOCAL_DEVICE_INFO_PROVIDER_H_ |
| 7 | 7 |
| 8 #include <memory> | 8 #include <memory> |
| 9 #include <string> | 9 #include <string> |
| 10 | 10 |
| 11 #include "base/callback_list.h" | 11 #include "base/callback_list.h" |
| 12 | 12 |
| 13 namespace base { | 13 namespace base { |
| 14 class TaskRunner; | 14 class TaskRunner; |
| 15 } | 15 } |
| 16 | 16 |
| 17 namespace sync_driver { | 17 namespace sync_driver { |
| 18 | 18 |
| 19 class DeviceInfo; | 19 class DeviceInfo; |
| 20 | 20 |
| 21 // Interface for providing sync specific information about the | 21 // Interface for providing sync specific information about the |
| 22 // local device. | 22 // local device. |
| 23 class LocalDeviceInfoProvider { | 23 class LocalDeviceInfoProvider { |
| 24 public: | 24 public: |
| 25 typedef base::CallbackList<void(void)>::Subscription Subscription; | 25 typedef base::CallbackList<void(void)>::Subscription Subscription; |
| 26 | 26 |
| 27 virtual ~LocalDeviceInfoProvider() {} | 27 virtual ~LocalDeviceInfoProvider() {} |
| 28 | 28 |
| 29 // Returns sync's representation of the local device info; | 29 // Returns sync's representation of the local device info, or nullptr if the |
| 30 // NULL if the device info is unavailable. | 30 // device info is unavailable. The returned object is fully owned by |
| 31 // The returned object is fully owned by LocalDeviceInfoProvider (must not | 31 // LocalDeviceInfoProvider; it must not be freed by the caller and should not |
| 32 // be freed by the caller). It remains valid until LocalDeviceInfoProvider | 32 // be stored. |
| 33 // is destroyed. | |
| 34 virtual const DeviceInfo* GetLocalDeviceInfo() const = 0; | 33 virtual const DeviceInfo* GetLocalDeviceInfo() const = 0; |
| 35 | 34 |
| 36 // Constructs a user agent string (ASCII) suitable for use by the syncapi | 35 // Constructs a user agent string (ASCII) suitable for use by the syncapi |
| 37 // for any HTTP communication. This string is used by the sync backend for | 36 // for any HTTP communication. This string is used by the sync backend for |
| 38 // classifying client types when calculating statistics. | 37 // classifying client types when calculating statistics. |
| 39 virtual std::string GetSyncUserAgent() const = 0; | 38 virtual std::string GetSyncUserAgent() const = 0; |
| 40 | 39 |
| 41 // Returns a GUID string used for creation of the machine tag for | 40 // Returns a GUID string used for creation of the machine tag for |
| 42 // this local session; an empty sting if LocalDeviceInfoProvider hasn't been | 41 // this local session; an empty sting if LocalDeviceInfoProvider hasn't been |
| 43 // initialized yet. | 42 // initialized yet. |
| 44 virtual std::string GetLocalSyncCacheGUID() const = 0; | 43 virtual std::string GetLocalSyncCacheGUID() const = 0; |
| 45 | 44 |
| 46 // Starts initializing local device info. | 45 // Starts initializing local device info. |
| 47 virtual void Initialize( | 46 virtual void Initialize( |
| 48 const std::string& cache_guid, | 47 const std::string& cache_guid, |
| 49 const std::string& signin_scoped_device_id, | 48 const std::string& signin_scoped_device_id, |
| 50 const scoped_refptr<base::TaskRunner>& blocking_task_runner) = 0; | 49 const scoped_refptr<base::TaskRunner>& blocking_task_runner) = 0; |
| 51 | 50 |
| 52 // Registers a callback to be called when local device info becomes available. | 51 // Registers a callback to be called when local device info becomes available. |
| 53 // The callback will remain registered until the | 52 // The callback will remain registered until the |
| 54 // returned Subscription is destroyed, which must occur before the | 53 // returned Subscription is destroyed, which must occur before the |
| 55 // CallbackList is destroyed. | 54 // CallbackList is destroyed. |
| 56 virtual std::unique_ptr<Subscription> RegisterOnInitializedCallback( | 55 virtual std::unique_ptr<Subscription> RegisterOnInitializedCallback( |
| 57 const base::Closure& callback) = 0; | 56 const base::Closure& callback) = 0; |
| 57 |
| 58 // Clears all cached data, returning to an uninitialized state. |
| 59 virtual void Clear() = 0; |
| 58 }; | 60 }; |
| 59 | 61 |
| 60 } // namespace sync_driver | 62 } // namespace sync_driver |
| 61 | 63 |
| 62 #endif // COMPONENTS_SYNC_DRIVER_LOCAL_DEVICE_INFO_PROVIDER_H_ | 64 #endif // COMPONENTS_SYNC_DRIVER_LOCAL_DEVICE_INFO_PROVIDER_H_ |
| OLD | NEW |