Migrates QUIC sessions to a new network when old network is (about to be) disconnected.

net/quic/quic_stream_factory.h

 // Copyright (c) 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.
 
 #ifndef NET_QUIC_QUIC_STREAM_FACTORY_H_
 #define NET_QUIC_QUIC_STREAM_FACTORY_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 93 matching lines @@
   CompletionCallback callback_;
   scoped_ptr<QuicHttpStream> stream_;
 
   DISALLOW_COPY_AND_ASSIGN(QuicStreamRequest);
 };
 
 // A factory for creating new QuicHttpStreams on top of a pool of
 // QuicChromiumClientSessions.
 class NET_EXPORT_PRIVATE QuicStreamFactory
     : public NetworkChangeNotifier::IPAddressObserver,
+      public NetworkChangeNotifier::NetworkObserver,
       public SSLConfigService::Observer,
       public CertDatabase::Observer {
  public:
   QuicStreamFactory(
       HostResolver* host_resolver,
       ClientSocketFactory* client_socket_factory,
       base::WeakPtr<HttpServerProperties> http_server_properties,
       CertVerifier* cert_verifier,
       CertPolicyEnforcer* cert_policy_enforcer,
       ChannelIDService* channel_id_service,
@@ skipping 17 matching lines @@
       int max_number_of_lossy_connections,
       float packet_loss_threshold,
       int max_recent_disabled_reasons,
       int threshold_timeouts_with_streams_open,
       int threshold_public_resets_post_handshake,
       int socket_receive_buffer_size,
       bool delay_tcp_race,
       bool store_server_configs_in_properties,
       bool close_sessions_on_ip_change,
       int idle_connection_timeout_seconds,
+      bool migrate_sessions_on_network_change,
       const QuicTagVector& connection_options);
   ~QuicStreamFactory() override;
 
   // Creates a new QuicHttpStream to |host_port_pair| which will be
   // owned by |request|.
   // If a matching session already exists, this method will return OK.  If no
   // matching session exists, this will return ERR_IO_PENDING and will invoke
   // OnRequestComplete asynchronously.
   int Create(const HostPortPair& host_port_pair,
              PrivacyMode privacy_mode,
@@ skipping 33 matching lines @@
 
   // Called by a session after it shuts down.
   void OnSessionClosed(QuicChromiumClientSession* session);
 
   // Called by a session whose connection has timed out.
   void OnSessionConnectTimeout(QuicChromiumClientSession* session);
 
   // Cancels a pending request.
   void CancelRequest(QuicStreamRequest* request);
 
-  // Closes all current sessions.
-  void CloseAllSessions(int error);
+  // Closes all current sessions with specified network and QUIC error codes.
+  void CloseAllSessions(int error, QuicErrorCode quic_error);
 
   scoped_ptr<base::Value> QuicStreamFactoryInfoToValue() const;
 
   // Delete all cached state objects in |crypto_config_|.
   void ClearCachedStatesInCryptoConfig();
 
+  // Helper method that configures a DatagramClientSocket. Socket is
+  // bound to the default network if the |network| param is
+  // NetworkChangeNotifier::kInvalidNetworkHandle.
+  // Returns net_error code.
+  int ConfigureSocket(DatagramClientSocket* socket,
+                      IPEndPoint addr,
+                      NetworkChangeNotifier::NetworkHandle network);
+
+  // Helper method that initiates migration of active sessions
+  // currently bound to |network| to an alternate network, if one
+  // exists. Idle sessions bound to |network| are closed. If there is
+  // no alternate network to migrate active sessions onto, active
+  // sessions are closed if |force_close| is true, and continue using
+  // |network| otherwise. Sessions not bound to |network| are left unchanged.
+  void MaybeMigrateOrCloseSessions(NetworkChangeNotifier::NetworkHandle network,
+                                   bool force_close);
+
   // NetworkChangeNotifier::IPAddressObserver methods:
 
   // Until the servers support roaming, close all connections when the local
   // IP address changes.
   void OnIPAddressChanged() override;
 
+  // NetworkChangeNotifier::NetworkObserver methods:
+
+  // Called when device connects to |network|. For example device associates
+  // with a WiFi access point. This does not imply the network has Internet
+  // access as it may well be behind a captive portal.
+  void OnNetworkConnected(
+      NetworkChangeNotifier::NetworkHandle network) override;
+  // Called when device disconnects from |network|.
+  void OnNetworkDisconnected(
+      NetworkChangeNotifier::NetworkHandle network) override;
+  // Called when device determines the connection to |network| is no longer
+  // preferred, for example when a device transitions from cellular to WiFi
+  // it might deem the cellular connection no longer preferred. The device
+  // will disconnect from |network| in a period of time (30s on Android),
+  // allowing network communications via |network| to wrap up.
+  void OnNetworkSoonToDisconnect(
+      NetworkChangeNotifier::NetworkHandle network) override;
+  // Called when |network| is made the default network for communication.

[Ryan Hamilton, 2016/01/08 05:01:06]

nit: the style guide suggests that these comments go where the method is
defined, not where it is overridden.

[Jana, 2016/01/09 02:06:53]

I removed the comments, since they were redundant. I have added the cellular ->
wifi comment at the definition, PTAL. I'm happy to add more comments where
appropriate, so let me know if you'd like me to add anything else here.

+  void OnNetworkMadeDefault(
+      NetworkChangeNotifier::NetworkHandle network) override;
+
   // SSLConfigService::Observer methods:
 
   // We perform the same flushing as described above when SSL settings change.
   void OnSSLConfigChanged() override;
 
   // CertDatabase::Observer methods:
 
   // We close all sessions when certificate database is changed.
   void OnCertAdded(const X509Certificate* cert) override;
   void OnCACertChanged(const X509Certificate* cert) override;
@@ skipping 217 matching lines @@
   // QuicPacketReader::StartReading() yields by doing a PostTask().
   int yield_after_packets_;
   QuicTime::Delta yield_after_duration_;
 
   // Set if server configs are to be stored in HttpServerProperties.
   bool store_server_configs_in_properties_;
 
   // Set if all sessions should be closed when any local IP address changes.
   const bool close_sessions_on_ip_change_;
 
+  // Set if migration should be attempted on active sessions when primary
+  // interface changes.
+  const bool migrate_sessions_on_network_change_;
+
   // Each profile will (probably) have a unique port_seed_ value.  This value
   // is used to help seed a pseudo-random number generator (PortSuggester) so
   // that we consistently (within this profile) suggest the same ephemeral
   // port when we re-connect to any given server/port.  The differences between
   // profiles (probablistically) prevent two profiles from colliding in their
   // ephemeral port requests.
   uint64_t port_seed_;
 
   // Local address of socket that was created in CreateSession.
   IPEndPoint local_address_;
   bool check_persisted_supports_quic_;
   bool has_initialized_data_;
   std::set<HostPortPair> quic_supported_servers_at_startup_;
 
   NetworkConnection network_connection_;
 
   base::TaskRunner* task_runner_;
 
   base::WeakPtrFactory<QuicStreamFactory> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(QuicStreamFactory);
 };
 
 }  // namespace net
 
 #endif  // NET_QUIC_QUIC_STREAM_FACTORY_H_