Client-to-server messages in GCMNetworkChannel

sync/notifier/sync_system_resources.h

 // Copyright 2012 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.
 //
 // Simple system resources class that uses the current message loop
 // for scheduling.  Assumes the current message loop is already
 // running.
 
 #ifndef SYNC_NOTIFIER_SYNC_SYSTEM_RESOURCES_H_
 #define SYNC_NOTIFIER_SYNC_SYSTEM_RESOURCES_H_
 
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/threading/non_thread_safe.h"
 #include "google/cacheinvalidation/include/system-resources.h"
 #include "jingle/notifier/base/notifier_options.h"
 #include "sync/base/sync_export.h"
 #include "sync/notifier/invalidator_state.h"
 #include "sync/notifier/state_writer.h"
 
 namespace syncer {
 
+class GCMNetworkChannelDelegate;
+
 class SyncLogger : public invalidation::Logger {
  public:
   SyncLogger();
 
   virtual ~SyncLogger();
 
   // invalidation::Logger implementation.
   virtual void Log(LogLevel level, const char* file, int line,
                    const char* format, ...) OVERRIDE;
 
@@ skipping 77 matching lines @@
 
   // Classes interested in network channel state changes should implement
   // SyncNetworkChannel::Observer and register here.
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Helper functions that know how to construct network channels from channel
   // specific parameters.
   static scoped_ptr<SyncNetworkChannel> CreatePushClientChannel(
       const notifier::NotifierOptions& notifier_options);
-  static scoped_ptr<SyncNetworkChannel> CreateGCMNetworkChannel();
+  static scoped_ptr<SyncNetworkChannel> CreateGCMNetworkChannel(
+      scoped_refptr<net::URLRequestContextGetter> request_context_getter,
+      scoped_ptr<GCMNetworkChannelDelegate> delegate);
 
   const std::string& GetServiceContextForTest() const;
 
   int64 GetSchedulingHashForTest() const;
 
   static std::string EncodeMessageForTest(
       const std::string& message,
       const std::string& service_context,
       int64 scheduling_hash);
 
   static bool DecodeMessageForTest(
       const std::string& notification,
       std::string* message,
       std::string* service_context,
       int64* scheduling_hash);
 
  protected:
-  // Subclass should notify about connection state through NotifyStateChange.
-  void NotifyStateChange(InvalidatorState invalidator_state);
+  // Subclass should notify about connection state through SetNetworkState.
+  void SetNetworkState(InvalidatorState invalidator_state);

[rlarocque, 2014/01/16 18:52:48]

Is this change related to your efforts to make state changes be handled
differently for GCM and XMPP channels?

Looking at the code as it currently exists, I think that NotifyStateChange() is
the better name.  Were you planning to make other changes that would make this
name a bad description?

[pavely, 2014/01/17 00:44:39]

One scenario that I considered was to use this function to report network state
after each operation. This way there would be lots of calls for no state change.
In this function implementation I only notify state change if state actually
changed.
I ended up reverting change that uses this and I'm not sure I'll need this
behavior in the future so I'll revert function name and implementation change as
well.

On 2014/01/16 18:52:48, rlarocque wrote:

   // Subclass should call DeliverIncomingMessage for message to reach
   // invalidations library.
   void DeliverIncomingMessage(const std::string& message);
 
  private:
   typedef std::vector<invalidation::NetworkStatusCallback*>
       NetworkStatusReceiverList;
 
   static void EncodeMessage(
       std::string* encoded_message,
@@ skipping 87 matching lines @@
   scoped_ptr<SyncInvalidationScheduler> internal_scheduler_;
   scoped_ptr<SyncInvalidationScheduler> listener_scheduler_;
   scoped_ptr<SyncStorage> storage_;
   // sync_network_channel_ is owned by SyncInvalidationListener.
   SyncNetworkChannel* sync_network_channel_;
 };
 
 }  // namespace syncer
 
 #endif  // SYNC_NOTIFIER_SYNC_SYSTEM_RESOURCES_H_