Close idle sockets next time we are about to send data.

net/socket/client_socket_pool_base.h

 // Copyright (c) 2011 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.
 //
 // A ClientSocketPoolBase is used to restrict the number of sockets open at
 // a time.  It also maintains a list of idle persistent sockets for reuse.
 // Subclasses of ClientSocketPool should compose ClientSocketPoolBase to handle
 // the core logic of (1) restricting the number of active (connected or
 // connecting) sockets per "group" (generally speaking, the hostname), (2)
 // maintaining a per-group list of idle, persistent sockets for reuse, and (3)
@@ skipping 298 matching lines @@
   static bool set_connect_backup_jobs_enabled(bool enabled);
 
   void EnableConnectBackupJobs();
 
   // ConnectJob::Delegate methods:
   virtual void OnConnectJobComplete(int result, ConnectJob* job);
 
   // NetworkChangeNotifier::IPAddressObserver methods:
   virtual void OnIPAddressChanged();
 
+  // Called to enable/disable cleaning up idle sockets. When enabled,
+  // idle sockets that has been around for longer than a period

[mmenke, 2011/11/11 03:33:01]

nit:  Maybe 'idle sockets that have been around too long.'
(has -> have, and it's a little weird to mention use 'a period' without more
elaboration on just how long it is).

[selim, 2011/11/11 19:30:58]

done

+  // are cleaned up using a timer. Otherwise they are closed next time
+  // client makes a request. This may reduce network activity and power
+  // consumption.
+  bool cleanup_timer_enabled();

[mmenke, 2011/11/11 03:33:01]

Put these functions in the same location relative to the other functions as you
use below, or vice versa.

[mmenke, 2011/11/11 03:33:01]

nit: Use const whenever appropriate.

[selim, 2011/11/11 19:30:58]

done

[selim, 2011/11/11 19:30:58]

done

+  void set_cleanup_timer_enabled( bool enabled );

[mmenke, 2011/11/11 03:33:01]

Since this is more than a simple setter, use SetCleanupTimerEnabled(), and for
the functions that wrap it as well.

[mmenke, 2011/11/11 03:33:01]

nit:  Google style is "(bool enabled)".  See
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Function_Decla...)

[selim, 2011/11/11 19:30:58]

done

+
  private:
   friend class base::RefCounted<ClientSocketPoolBaseHelper>;
 
   // Entry for a persistent socket which became idle at time |start_time|.
   struct IdleSocket {
     IdleSocket() : socket(NULL) {}
 
     // An idle socket should be removed if it can't be reused, or has been idle
     // for too long. |now| is the current time value (TimeTicks::Now()).
     // |timeout| is the length of time to wait before timing out an idle socket.
@@ skipping 106 matching lines @@
                                                Group* group);
 
   Group* GetOrCreateGroup(const std::string& group_name);
   void RemoveGroup(const std::string& group_name);
   void RemoveGroup(GroupMap::iterator it);
 
   // Called when the number of idle sockets changes.
   void IncrementIdleCount();
   void DecrementIdleCount();
 
+  // Start cleanup timer for idle sockets.
+  void startIdleSocketTimer();

[mmenke, 2011/11/11 03:33:01]

nit:  Google style is "StartIdleSocketTimer()".  See
http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Function_Names

[selim, 2011/11/11 19:30:58]

done

+
   // Scans the group map for groups which have an available socket slot and
   // at least one pending request. Returns true if any groups are stalled, and
   // if so, fills |group| and |group_name| with data of the stalled group
   // having highest priority.
   bool FindTopStalledGroup(Group** group, std::string* group_name);
 
   // Called when timer_ fires.  This method scans the idle sockets removing
   // sockets that timed out or can't be reused.
   void OnCleanupTimerFired() {
     CleanupIdleSockets(false);
@@ skipping 90 matching lines @@
 
   // Number of connected sockets we handed out across all groups.
   int handed_out_socket_count_;
 
   // The maximum total number of sockets. See ReachedMaxSocketsLimit.
   const int max_sockets_;
 
   // The maximum number of sockets kept per group.
   const int max_sockets_per_group_;
 
+  // Whether to use timer to cleanup idle sockets.
+  bool use_cleanup_timer_;
+
   // The time to wait until closing idle sockets.
   const base::TimeDelta unused_idle_socket_timeout_;
   const base::TimeDelta used_idle_socket_timeout_;
 
   const scoped_ptr<ConnectJobFactory> connect_job_factory_;
 
   // TODO(vandebo) Remove when backup jobs move to TransportClientSocketPool
   bool connect_backup_jobs_enabled_;
 
   // A unique id for the pool.  It gets incremented every time we Flush() the
@@ skipping 133 matching lines @@
   }
 
   int NumActiveSocketsInGroup(const std::string& group_name) const {
     return helper_.NumActiveSocketsInGroup(group_name);
   }
 
   bool HasGroup(const std::string& group_name) const {
     return helper_.HasGroup(group_name);
   }
 
+  bool cleanup_timer_enabled() {

[mmenke, 2011/11/11 03:33:01]

nit:  const

[selim, 2011/11/11 19:30:58]

done

+    return helper_.cleanup_timer_enabled();
+  }
+
+  void set_cleanup_timer_enabled( bool enabled ) {

[mmenke, 2011/11/11 03:33:01]

nit: Google style is "(bool enabled)"

[selim, 2011/11/11 19:30:58]

done

+    return helper_.set_cleanup_timer_enabled( enabled );

[mmenke, 2011/11/11 03:33:01]

nit: Google style is "(enabled)"

[selim, 2011/11/11 19:30:58]

done

+  }
+
   void CleanupIdleSockets(bool force) {
     return helper_.CleanupIdleSockets(force);
   }
 
   base::DictionaryValue* GetInfoAsValue(const std::string& name,
                                         const std::string& type) const {
     return helper_.GetInfoAsValue(name, type);
   }
 
   base::TimeDelta ConnectionTimeout() const {
@@ skipping 43 matching lines @@
   // Histograms for the pool
   ClientSocketPoolHistograms* const histograms_;
   internal::ClientSocketPoolBaseHelper helper_;
 
   DISALLOW_COPY_AND_ASSIGN(ClientSocketPoolBase);
 };
 
 }  // namespace net
 
 #endif  // NET_SOCKET_CLIENT_SOCKET_POOL_BASE_H_