UKM Sync Observer

components/ukm/ukm_service.h

 // Copyright 2017 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.
 
 #ifndef COMPONENTS_UKM_UKM_SERVICE_H_
 #define COMPONENTS_UKM_UKM_SERVICE_H_
 
 #include <stddef.h>
 #include <memory>
 #include <vector>
@@ skipping 29 matching lines @@
  public:
   // Constructs a UkmService.
   // Calling code is responsible for ensuring that the lifetime of
   // |pref_service| is longer than the lifetime of UkmService.
   UkmService(PrefService* pref_service, metrics::MetricsServiceClient* client);
   virtual ~UkmService();
 
   // Initializes the UKM service.
   void Initialize();
 
+  // Enables/disables recording control if data is allowed to be collected.
+  void EnableRecording();
+  void DisableRecording();
+
   // Enables/disables transmission of accumulated logs. Logs that have already
   // been created will remain persisted to disk.
   void EnableReporting();
   void DisableReporting();
 
   // Adds a new source of UKM metrics, which will be stored
   // until periodically serialized for upload, and then deleted.
   void RecordSource(std::unique_ptr<UkmSource> source);
 
   // Records any collected data into logs, and writes to disk.
   void Flush();
 
   // Deletes any unsent local data.
   void Purge();
 
+  // Resets the client id stored in prefs.
+  void ResetClientId();
+
   // Registers the specified |provider| to provide additional metrics into the
   // UKM log. Should be called during MetricsService initialization only.
   void RegisterMetricsProvider(
       std::unique_ptr<metrics::MetricsProvider> provider);
 
   // Registers the names of all of the preferences used by UkmService in
   // the provided PrefRegistry.
   static void RegisterPrefs(PrefRegistrySimple* registry);
 
  protected:
@@ skipping 18 matching lines @@
 
   // Starts an upload of the next log from persisted_logs_.
   void StartScheduledUpload();
 
   // Called by log_uploader_ when the an upload is completed.
   void OnLogUploadComplete(int response_code);
 
   // A weak pointer to the PrefService used to read and write preferences.
   PrefService* pref_service_;
 
+  // Whether recording new data is currently allowed.
+  bool recording_enabled_;
+
   // The UKM client id stored in prefs.
   uint64_t client_id_;
 
   // Used to interact with the embedder. Weak pointer; must outlive |this|
   // instance.
   metrics::MetricsServiceClient* const client_;
 
   // Registered metrics providers.
   std::vector<std::unique_ptr<metrics::MetricsProvider>> metrics_providers_;
 
@@ skipping 19 matching lines @@
   // Weak pointers factory used to post task on different threads. All weak
   // pointers managed by this factory have the same lifetime as UkmService.
   base::WeakPtrFactory<UkmService> self_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(UkmService);
 };
 
 }  // namespace ukm
 
 #endif  // COMPONENTS_UKM_UKM_SERVICE_H_