15c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu// Copyright 2014 The Chromium Authors. All rights reserved. 25c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu// Use of this source code is governed by a BSD-style license that can be 35c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu// found in the LICENSE file. 45c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 5cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#ifndef COMPONENTS_GCM_DRIVER_GCM_DRIVER_H_ 6cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#define COMPONENTS_GCM_DRIVER_GCM_DRIVER_H_ 75c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 85c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu#include <map> 95c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu#include <string> 105c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu#include <vector> 115c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 125c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu#include "base/callback.h" 1346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)#include "base/macros.h" 1446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)#include "base/threading/thread_checker.h" 15cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "components/gcm_driver/default_gcm_app_handler.h" 16f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles)#include "components/gcm_driver/gcm_client.h" 175c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 185c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liunamespace gcm { 195c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 205c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liuclass GCMAppHandler; 215c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 2246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)// Bridge between GCM users in Chrome and the platform-specific implementation. 2346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)class GCMDriver { 245c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu public: 25cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) typedef std::map<std::string, GCMAppHandler*> GCMAppHandlerMap; 265c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu typedef base::Callback<void(const std::string& registration_id, 275c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu GCMClient::Result result)> RegisterCallback; 285c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu typedef base::Callback<void(const std::string& message_id, 295c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu GCMClient::Result result)> SendCallback; 305c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu typedef base::Callback<void(GCMClient::Result result)> UnregisterCallback; 315c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu typedef base::Callback<void(const GCMClient::GCMStatistics& stats)> 325c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu GetGCMStatisticsCallback; 335c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 3446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) GCMDriver(); 35cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual ~GCMDriver(); 36cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 375c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Registers |sender_id| for an app. A registration ID will be returned by 385c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // the GCM server. 395c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |app_id|: application ID. 405c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |sender_ids|: list of IDs of the servers that are allowed to send the 415c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // messages to the application. These IDs are assigned by the 425c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Google API Console. 435c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |callback|: to be called once the asynchronous operation is done. 4446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) void Register(const std::string& app_id, 4546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const std::vector<std::string>& sender_ids, 4646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const RegisterCallback& callback); 475c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 485c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Unregisters an app from using GCM. 495c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |app_id|: application ID. 505c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |callback|: to be called once the asynchronous operation is done. 5146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) void Unregister(const std::string& app_id, 5246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const UnregisterCallback& callback); 535c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 545c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Sends a message to a given receiver. 555c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |app_id|: application ID. 565c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |receiver_id|: registration ID of the receiver party. 575c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |message|: message to be sent. 585c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // |callback|: to be called once the asynchronous operation is done. 5946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) void Send(const std::string& app_id, 6046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const std::string& receiver_id, 6146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const GCMClient::OutgoingMessage& message, 6246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const SendCallback& callback); 6346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 6446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const GCMAppHandlerMap& app_handlers() const { return app_handlers_; } 655c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 6646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // This method must be called before destroying the GCMDriver. Once it has 6746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // been called, no other GCMDriver methods may be used. 6846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void Shutdown(); 6946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 70f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Call this method when the user signs in to a GAIA account. 71f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // TODO(jianli): To be removed when sign-in enforcement is dropped. 72f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual void OnSignedIn() = 0; 73f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 74f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Removes all the cached and persisted GCM data. If the GCM service is 75f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // restarted after the purge, a new Android ID will be obtained. 76f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual void Purge() = 0; 77f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 7846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Adds a handler for a given app. 7946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void AddAppHandler(const std::string& app_id, GCMAppHandler* handler); 8046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 8146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Remove the handler for a given app. 8246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void RemoveAppHandler(const std::string& app_id); 8346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 84f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Returns the handler for the given app. 85f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) GCMAppHandler* GetAppHandler(const std::string& app_id); 86f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 8746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Enables/disables GCM service. 8846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void Enable() = 0; 8946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void Disable() = 0; 9046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 9146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // For testing purpose. Always NULL on Android. 9246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual GCMClient* GetGCMClientForTesting() const = 0; 935c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 945c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Returns true if the service was started. 9546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual bool IsStarted() const = 0; 965c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 97f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) // Returns true if the gcm client has an open and active connection. 98f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) virtual bool IsConnected() const = 0; 99f8ee788a64d60abd8f2d742a5fdedde054ecd910Torne (Richard Coles) 1005c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Get GCM client internal states and statistics. 1015c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // If clear_logs is true then activity logs will be cleared before the stats 1025c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // are returned. 10346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void GetGCMStatistics(const GetGCMStatisticsCallback& callback, 10446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) bool clear_logs) = 0; 1055c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 1065c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Enables/disables GCM activity recording, and then returns the stats. 10746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void SetGCMRecording(const GetGCMStatisticsCallback& callback, 10846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) bool recording) = 0; 109cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 110cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) protected: 11146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Ensures that the GCM service starts (if necessary conditions are met). 11246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual GCMClient::Result EnsureStarted() = 0; 1135c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 11446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Platform-specific implementation of Register. 11546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void RegisterImpl(const std::string& app_id, 11646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const std::vector<std::string>& sender_ids) = 0; 1175c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 11846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Platform-specific implementation of Unregister. 11946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void UnregisterImpl(const std::string& app_id) = 0; 1205c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 12146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Platform-specific implementation of Send. 12246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void SendImpl(const std::string& app_id, 12346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const std::string& receiver_id, 12446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) const GCMClient::OutgoingMessage& message) = 0; 1255c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 12646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Runs the Register callback. 1275c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu void RegisterFinished(const std::string& app_id, 1285c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu const std::string& registration_id, 1295c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu GCMClient::Result result); 13046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 13146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Runs the Unregister callback. 13246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) void UnregisterFinished(const std::string& app_id, 13346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) GCMClient::Result result); 13446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 13546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Runs the Send callback. 1365c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu void SendFinished(const std::string& app_id, 1375c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu const std::string& message_id, 1385c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu GCMClient::Result result); 1395c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 14046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) bool HasRegisterCallback(const std::string& app_id); 141cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 14246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) void ClearCallbacks(); 1435c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 14446d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) private: 14546d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Should be called when an app with |app_id| is trying to un/register. 14646d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // Checks whether another un/registration is in progress. 14746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) bool IsAsyncOperationPending(const std::string& app_id) const; 1485c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 1495c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Callback map (from app_id to callback) for Register. 1505c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu std::map<std::string, RegisterCallback> register_callbacks_; 1515c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 1525c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Callback map (from app_id to callback) for Unregister. 1535c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu std::map<std::string, UnregisterCallback> unregister_callbacks_; 1545c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 1555c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu // Callback map (from <app_id, message_id> to callback) for Send. 1565c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu std::map<std::pair<std::string, std::string>, SendCallback> send_callbacks_; 1575c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 15846d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // App handler map (from app_id to handler pointer). 15946d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // The handler is not owned. 16046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) GCMAppHandlerMap app_handlers_; 1615c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 16246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) // The default handler when no app handler can be found in the map. 16346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) DefaultGCMAppHandler default_app_handler_; 1645c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 165cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(GCMDriver); 1665c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu}; 1675c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 1685c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu} // namespace gcm 1695c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu 170cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#endif // COMPONENTS_GCM_DRIVER_GCM_DRIVER_H_ 171