[GCM] Wiring heartbeat interval calls to GCMDriver

components/gcm_driver/gcm_driver.h

 // Copyright 2014 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_GCM_DRIVER_GCM_DRIVER_H_
 #define COMPONENTS_GCM_DRIVER_GCM_DRIVER_H_
 
 #include <map>
 #include <string>
 #include <vector>
@@ skipping 128 matching lines @@
   virtual void RemoveAccountMapping(const std::string& account_id) = 0;
 
   // Getter and setter of last token fetch time.
   virtual base::Time GetLastTokenFetchTime() = 0;
   virtual void SetLastTokenFetchTime(const base::Time& time) = 0;
 
   // Sets whether or not GCM should try to wake the system from suspend in order
   // to send a heartbeat message.
   virtual void WakeFromSuspendForHeartbeat(bool wake) = 0;
 
+  // Adds or removes a custom client requested heartbeat interval. If multiple
+  // components set that setting, the lowest setting will be used. If the
+  // setting is outside of GetMax/MinClientHeartbeatIntervalMs() it will be
+  // ignored. If a new setting is less than the currently used, the connection
+  // will be reset with the new heartbeat. Client that no longer require
+  // aggressive heartbeats, should remove their requested interval. Heartbeats
+  // set this way survive connection/Chrome restart.
+  // Server can overwrite the setting to a different value.
+  virtual void AddHeartbeatInterval(const std::string& scope,

[Nicolas Zea, 2015/05/07 18:13:52]

nit: describe what scope is and how it should be set.

Also, any rules as to when this is allowed to be called?

[fgorski, 2015/05/10 06:44:34]

Done.

+                                    int interval_ms) = 0;
+  virtual void RemoveHeartbeatInterval(const std::string& scope) = 0;
+
  protected:
   // Ensures that the GCM service starts (if necessary conditions are met).
   virtual GCMClient::Result EnsureStarted(GCMClient::StartMode start_mode) = 0;
 
   // Platform-specific implementation of Register.
   virtual void RegisterImpl(const std::string& app_id,
                             const std::vector<std::string>& sender_ids) = 0;
 
   // Platform-specific implementation of Unregister.
   virtual void UnregisterImpl(const std::string& app_id) = 0;
@@ skipping 56 matching lines @@
   DefaultGCMAppHandler default_app_handler_;
 
   base::WeakPtrFactory<GCMDriver> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GCMDriver);
 };
 
 }  // namespace gcm
 
 #endif  // COMPONENTS_GCM_DRIVER_GCM_DRIVER_H_