OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef NET_SOCKET_CLIENT_SOCKET_POOL_H_ | 5 #ifndef NET_SOCKET_CLIENT_SOCKET_POOL_H_ |
6 #define NET_SOCKET_CLIENT_SOCKET_POOL_H_ | 6 #define NET_SOCKET_CLIENT_SOCKET_POOL_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include <deque> | 9 #include <deque> |
10 #include <string> | 10 #include <string> |
11 | 11 |
(...skipping 10 matching lines...) Expand all Loading... |
22 namespace base { | 22 namespace base { |
23 class DictionaryValue; | 23 class DictionaryValue; |
24 } | 24 } |
25 | 25 |
26 namespace net { | 26 namespace net { |
27 | 27 |
28 class ClientSocketHandle; | 28 class ClientSocketHandle; |
29 class ClientSocketPoolHistograms; | 29 class ClientSocketPoolHistograms; |
30 class StreamSocket; | 30 class StreamSocket; |
31 | 31 |
| 32 // ClientSocketPools are layered. This defines an interface for lower level |
| 33 // socket pools to communicate with higher layer pools. |
| 34 class NET_EXPORT LayeredPool { |
| 35 public: |
| 36 virtual ~LayeredPool() {} |
| 37 |
| 38 // Instructs the LayeredPool to close an idle connection. Return true if one |
| 39 // was closed. |
| 40 virtual bool CloseOneIdleConnection() = 0; |
| 41 }; |
| 42 |
32 // A ClientSocketPool is used to restrict the number of sockets open at a time. | 43 // A ClientSocketPool is used to restrict the number of sockets open at a time. |
33 // It also maintains a list of idle persistent sockets. | 44 // It also maintains a list of idle persistent sockets. |
34 // | 45 // |
35 class NET_EXPORT ClientSocketPool { | 46 class NET_EXPORT ClientSocketPool { |
36 public: | 47 public: |
37 // Requests a connected socket for a group_name. | 48 // Requests a connected socket for a group_name. |
38 // | 49 // |
39 // There are five possible results from calling this function: | 50 // There are five possible results from calling this function: |
40 // 1) RequestSocket returns OK and initializes |handle| with a reused socket. | 51 // 1) RequestSocket returns OK and initializes |handle| with a reused socket. |
41 // 2) RequestSocket returns OK with a newly connected socket. | 52 // 2) RequestSocket returns OK with a newly connected socket. |
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
103 virtual void ReleaseSocket(const std::string& group_name, | 114 virtual void ReleaseSocket(const std::string& group_name, |
104 StreamSocket* socket, | 115 StreamSocket* socket, |
105 int id) = 0; | 116 int id) = 0; |
106 | 117 |
107 // This flushes all state from the ClientSocketPool. This means that all | 118 // This flushes all state from the ClientSocketPool. This means that all |
108 // idle and connecting sockets are discarded. Active sockets being | 119 // idle and connecting sockets are discarded. Active sockets being |
109 // held by ClientSocketPool clients will be discarded when released back to | 120 // held by ClientSocketPool clients will be discarded when released back to |
110 // the pool. Does not flush any pools wrapped by |this|. | 121 // the pool. Does not flush any pools wrapped by |this|. |
111 virtual void Flush() = 0; | 122 virtual void Flush() = 0; |
112 | 123 |
| 124 // Returns true if a there is currently a request blocked on the |
| 125 // per-pool (not per-host) max socket limit. |
| 126 virtual bool IsStalled() const = 0; |
| 127 |
113 // Called to close any idle connections held by the connection manager. | 128 // Called to close any idle connections held by the connection manager. |
114 virtual void CloseIdleSockets() = 0; | 129 virtual void CloseIdleSockets() = 0; |
115 | 130 |
116 // The total number of idle sockets in the pool. | 131 // The total number of idle sockets in the pool. |
117 virtual int IdleSocketCount() const = 0; | 132 virtual int IdleSocketCount() const = 0; |
118 | 133 |
119 // The total number of idle sockets in a connection group. | 134 // The total number of idle sockets in a connection group. |
120 virtual int IdleSocketCountInGroup(const std::string& group_name) const = 0; | 135 virtual int IdleSocketCountInGroup(const std::string& group_name) const = 0; |
121 | 136 |
122 // Determine the LoadState of a connecting ClientSocketHandle. | 137 // Determine the LoadState of a connecting ClientSocketHandle. |
123 virtual LoadState GetLoadState(const std::string& group_name, | 138 virtual LoadState GetLoadState(const std::string& group_name, |
124 const ClientSocketHandle* handle) const = 0; | 139 const ClientSocketHandle* handle) const = 0; |
125 | 140 |
| 141 // Adds a LayeredPool on top of |this|. |
| 142 virtual void AddLayeredPool(LayeredPool* layered_pool) = 0; |
| 143 |
| 144 // Removes a LayeredPool from |this|. |
| 145 virtual void RemoveLayeredPool(LayeredPool* layered_pool) = 0; |
| 146 |
126 // Retrieves information on the current state of the pool as a | 147 // Retrieves information on the current state of the pool as a |
127 // DictionaryValue. Caller takes possession of the returned value. | 148 // DictionaryValue. Caller takes possession of the returned value. |
128 // If |include_nested_pools| is true, the states of any nested | 149 // If |include_nested_pools| is true, the states of any nested |
129 // ClientSocketPools will be included. | 150 // ClientSocketPools will be included. |
130 virtual base::DictionaryValue* GetInfoAsValue( | 151 virtual base::DictionaryValue* GetInfoAsValue( |
131 const std::string& name, | 152 const std::string& name, |
132 const std::string& type, | 153 const std::string& type, |
133 bool include_nested_pools) const = 0; | 154 bool include_nested_pools) const = 0; |
134 | 155 |
135 // Returns the maximum amount of time to wait before retrying a connect. | 156 // Returns the maximum amount of time to wait before retrying a connect. |
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
190 const scoped_refptr<SocketParams>& params, | 211 const scoped_refptr<SocketParams>& params, |
191 int num_sockets, | 212 int num_sockets, |
192 const BoundNetLog& net_log) { | 213 const BoundNetLog& net_log) { |
193 CheckIsValidSocketParamsForPool<PoolType, SocketParams>(); | 214 CheckIsValidSocketParamsForPool<PoolType, SocketParams>(); |
194 pool->RequestSockets(group_name, ¶ms, num_sockets, net_log); | 215 pool->RequestSockets(group_name, ¶ms, num_sockets, net_log); |
195 } | 216 } |
196 | 217 |
197 } // namespace net | 218 } // namespace net |
198 | 219 |
199 #endif // NET_SOCKET_CLIENT_SOCKET_POOL_H_ | 220 #endif // NET_SOCKET_CLIENT_SOCKET_POOL_H_ |
OLD | NEW |