[GCM] Add TTL support

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/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;
 }
 
@@ skipping 25 matching lines @@
   // 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(ConnectionFactory* connection_factory, RMQStore* rmq_store);
+  MCSClient(base::Clock* clock,
+            ConnectionFactory* connection_factory,
+            RMQStore* rmq_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,
   // 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
   // values of 0 will be returned via |initialization_callback| with
   // |success == true|.
   /// If an error loading the RMQ 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);
 
   // 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.
-  // TODO(zea): support TTL.
-  void SendMessage(const MCSMessage& message, bool use_rmq);
+  // 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,
+  // OnMessageSent is invoked with a TTL expiration error.

[fgorski, 2013/12/28 01:15:08]

do you mean message_sent_callback_?

[Nicolas Zea, 2013/12/30 21:46:19]

Done.

+  void SendMessage(const MCSMessage& message);
 
   // Disconnects the client and permanently destroys the persistent RMQ 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:
@@ skipping 41 matching lines @@
   // acknowledgment of receipt of messages.
   void HandleServerConfirmedReceipt(StreamId device_stream_id);
 
   // Generates a new persistent id for messages.
   // Virtual for testing.
   virtual PersistentId GetNextPersistentId();
 
   // Helper for the heartbeat manager to signal a connection reset.
   void OnConnectionResetByHeartbeat();
 
+  // Clock for enforcing TTL. Passed in for testing.
+  base::Clock* const clock_;
+
   // Client state.
   State state_;
 
   // Callbacks for owner.
   InitializationCompleteCallback initialization_callback_;
   OnMessageReceivedCallback message_received_callback_;
   OnMessageSentCallback message_sent_callback_;
 
   // The android id and security token in use by this device.
   uint64 android_id_;
@@ skipping 48 matching lines @@
   HeartbeatManager heartbeat_manager_;
 
   base::WeakPtrFactory<MCSClient> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MCSClient);
 };
 
 } // namespace gcm
 
 #endif  // GOOGLE_APIS_GCM_ENGINE_MCS_CLIENT_H_