Renaming RMQStore to GCMStore and breaking out its interface

google_apis/gcm/engine/mcs_client.h

 // Copyright 2013 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 GOOGLE_APIS_GCM_ENGINE_MCS_CLIENT_H_
 #define GOOGLE_APIS_GCM_ENGINE_MCS_CLIENT_H_
 
 #include <deque>
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/files/file_path.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "google_apis/gcm/base/gcm_export.h"
 #include "google_apis/gcm/base/mcs_message.h"
 #include "google_apis/gcm/engine/connection_handler.h"
+#include "google_apis/gcm/engine/gcm_store.h"
 #include "google_apis/gcm/engine/heartbeat_manager.h"
-#include "google_apis/gcm/engine/rmq_store.h"
 
 namespace base {
 class Clock;
 }  // namespace base
 
 namespace google {
 namespace protobuf {
 class MessageLite;
 }  // namespace protobuf
 }  // namespace google
 
 namespace mcs_proto {
 class LoginRequest;
 }
 
 namespace gcm {
 
 class ConnectionFactory;
 struct ReliablePacketInfo;
 
 // An MCS client. This client is in charge of all communications with an
 // MCS endpoint, and is capable of reliably sending/receiving GCM messages.
 // NOTE: Not thread safe. This class should live on the same thread as that
 // network requests are performed on.
 class GCM_EXPORT MCSClient {
  public:
   enum State {
-    UNINITIALIZED,    // Uninitialized.
-    LOADED,           // RMQ Load finished, waiting to connect.
-    CONNECTING,       // Connection in progress.
-    CONNECTED,        // Connected and running.
+    UNINITIALIZED,  // Uninitialized.
+    LOADED,         // GCM Load finished, waiting to connect.
+    CONNECTING,     // Connection in progress.
+    CONNECTED,      // Connected and running.
   };
 
   // Callback for informing MCSClient status. It is valid for this to be
   // invoked more than once if a permanent error is encountered after a
   // successful login was initiated.
   typedef base::Callback<
       void(bool success,
            uint64 restored_android_id,
            uint64 restored_security_token)> InitializationCompleteCallback;
   // Callback when a message is received.
   typedef base::Callback<void(const MCSMessage& message)>
       OnMessageReceivedCallback;
   // Callback when a message is sent (and receipt has been acknowledged by
   // the MCS endpoint).
   // TODO(zea): pass some sort of structure containing more details about
   // send failures.
   typedef base::Callback<void(const std::string& message_id)>
       OnMessageSentCallback;
 
   MCSClient(base::Clock* clock,
             ConnectionFactory* connection_factory,
-            RMQStore* rmq_store);
+            GCMStore* gcm_store);
   virtual ~MCSClient();
 
   // Initialize the client. Will load any previous id/token information as well
-  // as unacknowledged message information from the RMQ storage, if it exists,
+  // as unacknowledged message information from the GCM storage, if it exists,
   // passing the id/token information back via |initialization_callback| along
-  // with a |success == true| result. If no RMQ information is present (and
-  // this is therefore a fresh client), a clean RMQ store will be created and
+  // with a |success == true| result. If no GCM information is present (and
+  // this is therefore a fresh client), a clean GCM store will be created and
   // values of 0 will be returned via |initialization_callback| with
   // |success == true|.
-  /// If an error loading the RMQ store is encountered,
+  /// If an error loading the GCM store is encountered,
   // |initialization_callback| will be invoked with |success == false|.
   void Initialize(const InitializationCompleteCallback& initialization_callback,
                   const OnMessageReceivedCallback& message_received_callback,
                   const OnMessageSentCallback& message_sent_callback,
-                  const RMQStore::LoadResult& load_result);
+                  const GCMStore::LoadResult& load_result);
 
   // Logs the client into the server. Client must be initialized.
   // |android_id| and |security_token| are optional if this is not a new
   // client, else they must be non-zero.
   // Successful login will result in |message_received_callback| being invoked
   // with a valid LoginResponse.
   // Login failure (typically invalid id/token) will shut down the client, and
   // |initialization_callback| to be invoked with |success = false|.
   void Login(uint64 android_id, uint64 security_token);
 
   // Sends a message, with or without reliable message queueing (RMQ) support.
   // Will asynchronously invoke the OnMessageSent callback regardless.
   // Whether to use RMQ depends on whether the protobuf has |ttl| set or not.
   // |ttl == 0| denotes the message should only be sent if the connection is
   // open. |ttl > 0| will keep the message saved for |ttl| seconds, after which
   // it will be dropped if it was unable to be sent. When a message is dropped,
   // |message_sent_callback_| is invoked with a TTL expiration error.
   void SendMessage(const MCSMessage& message);
 
-  // Disconnects the client and permanently destroys the persistent RMQ store.
+  // Disconnects the client and permanently destroys the persistent GCM store.
   // WARNING: This is permanent, and the client must be recreated with new
   // credentials afterwards.
   void Destroy();
 
   // Returns the current state of the client.
   State state() const { return state_; }
 
  private:
   typedef uint32 StreamId;
   typedef std::string PersistentId;
   typedef std::vector<StreamId> StreamIdList;
   typedef std::vector<PersistentId> PersistentIdList;
   typedef std::map<StreamId, PersistentId> StreamIdToPersistentIdMap;
   typedef linked_ptr<ReliablePacketInfo> MCSPacketInternal;
 
   // Resets the internal state and builds a new login request, acknowledging
   // any pending server-to-device messages and rebuilding the send queue
   // from all unacknowledged device-to-server messages.
   // Should only be called when the connection has been reset.
   void ResetStateAndBuildLoginRequest(mcs_proto::LoginRequest* request);
 
   // Send a heartbeat to the MCS server.
   void SendHeartbeat();
 
-  // RMQ Store callback.
-  void OnRMQUpdateFinished(bool success);
+  // GCM Store callback.
+  void OnGCMUpdateFinished(bool success);
 
   // Attempt to send a message.
   void MaybeSendMessage();
 
   // Helper for sending a protobuf along with any unacknowledged ids to the
   // wire.
   void SendPacketToWire(ReliablePacketInfo* packet_info);
 
   // Handle a data message sent to the MCS client system from the MCS server.
   void HandleMCSDataMesssage(
@@ skipping 70 matching lines @@
   // until the ack message is itself confirmed. The list of all message ids
   // acknowledged are keyed off the device stream id of the message that
   // acknowledged them.
   std::map<StreamId, PersistentIdList> acked_server_ids_;
 
   // Those server messages from a previous connection that were not fully
   // acknowledged. They do not have associated stream ids, and will be
   // acknowledged on the next login attempt.
   PersistentIdList restored_unackeds_server_ids_;
 
-  // The reliable message queue persistent store. Owned by the caller.
-  RMQStore* rmq_store_;
+  // The GCM persistent store. Not owned.
+  GCMStore* gcm_store_;
 
   // Manager to handle triggering/detecting heartbeats.
   HeartbeatManager heartbeat_manager_;
 
   base::WeakPtrFactory<MCSClient> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MCSClient);
 };
 
 } // namespace gcm
 
 #endif  // GOOGLE_APIS_GCM_ENGINE_MCS_CLIENT_H_