OLD | NEW |
1 // Copyright (c) 2011 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> |
(...skipping 11 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 LayeredPool { |
| 35 public: |
| 36 // Instructs the LayeredPool to close an idle connection. Return true if one |
| 37 // was closed. |
| 38 virtual bool CloseOneIdleConnection() = 0; |
| 39 }; |
| 40 |
32 // A ClientSocketPool is used to restrict the number of sockets open at a time. | 41 // A ClientSocketPool is used to restrict the number of sockets open at a time. |
33 // It also maintains a list of idle persistent sockets. | 42 // It also maintains a list of idle persistent sockets. |
34 // | 43 // |
35 class NET_EXPORT ClientSocketPool { | 44 class NET_EXPORT ClientSocketPool { |
36 public: | 45 public: |
37 // Requests a connected socket for a group_name. | 46 // Requests a connected socket for a group_name. |
38 // | 47 // |
39 // There are five possible results from calling this function: | 48 // There are five possible results from calling this function: |
40 // 1) RequestSocket returns OK and initializes |handle| with a reused socket. | 49 // 1) RequestSocket returns OK and initializes |handle| with a reused socket. |
41 // 2) RequestSocket returns OK with a newly connected socket. | 50 // 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, | 112 virtual void ReleaseSocket(const std::string& group_name, |
104 StreamSocket* socket, | 113 StreamSocket* socket, |
105 int id) = 0; | 114 int id) = 0; |
106 | 115 |
107 // This flushes all state from the ClientSocketPool. This means that all | 116 // This flushes all state from the ClientSocketPool. This means that all |
108 // idle and connecting sockets are discarded. Active sockets being | 117 // idle and connecting sockets are discarded. Active sockets being |
109 // held by ClientSocketPool clients will be discarded when released back to | 118 // held by ClientSocketPool clients will be discarded when released back to |
110 // the pool. Does not flush any pools wrapped by |this|. | 119 // the pool. Does not flush any pools wrapped by |this|. |
111 virtual void Flush() = 0; | 120 virtual void Flush() = 0; |
112 | 121 |
| 122 // Returns true if a new request may hit a per-pool (not per-host) max socket |
| 123 // limit. |
| 124 virtual bool IsStalled() const = 0; |
| 125 |
113 // Called to close any idle connections held by the connection manager. | 126 // Called to close any idle connections held by the connection manager. |
114 virtual void CloseIdleSockets() = 0; | 127 virtual void CloseIdleSockets() = 0; |
115 | 128 |
116 // The total number of idle sockets in the pool. | 129 // The total number of idle sockets in the pool. |
117 virtual int IdleSocketCount() const = 0; | 130 virtual int IdleSocketCount() const = 0; |
118 | 131 |
119 // The total number of idle sockets in a connection group. | 132 // The total number of idle sockets in a connection group. |
120 virtual int IdleSocketCountInGroup(const std::string& group_name) const = 0; | 133 virtual int IdleSocketCountInGroup(const std::string& group_name) const = 0; |
121 | 134 |
122 // Determine the LoadState of a connecting ClientSocketHandle. | 135 // Determine the LoadState of a connecting ClientSocketHandle. |
123 virtual LoadState GetLoadState(const std::string& group_name, | 136 virtual LoadState GetLoadState(const std::string& group_name, |
124 const ClientSocketHandle* handle) const = 0; | 137 const ClientSocketHandle* handle) const = 0; |
125 | 138 |
| 139 // Adds a LayeredPool on top of |this|. |
| 140 virtual void AddLayeredPool(LayeredPool* layered_pool) = 0; |
| 141 |
| 142 // Removes a LayeredPool from |this|. |
| 143 virtual void RemoveLayeredPool(LayeredPool* layered_pool) = 0; |
| 144 |
126 // Retrieves information on the current state of the pool as a | 145 // Retrieves information on the current state of the pool as a |
127 // DictionaryValue. Caller takes possession of the returned value. | 146 // DictionaryValue. Caller takes possession of the returned value. |
128 // If |include_nested_pools| is true, the states of any nested | 147 // If |include_nested_pools| is true, the states of any nested |
129 // ClientSocketPools will be included. | 148 // ClientSocketPools will be included. |
130 virtual base::DictionaryValue* GetInfoAsValue( | 149 virtual base::DictionaryValue* GetInfoAsValue( |
131 const std::string& name, | 150 const std::string& name, |
132 const std::string& type, | 151 const std::string& type, |
133 bool include_nested_pools) const = 0; | 152 bool include_nested_pools) const = 0; |
134 | 153 |
135 // Returns the maximum amount of time to wait before retrying a connect. | 154 // 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, | 209 const scoped_refptr<SocketParams>& params, |
191 int num_sockets, | 210 int num_sockets, |
192 const BoundNetLog& net_log) { | 211 const BoundNetLog& net_log) { |
193 CheckIsValidSocketParamsForPool<PoolType, SocketParams>(); | 212 CheckIsValidSocketParamsForPool<PoolType, SocketParams>(); |
194 pool->RequestSockets(group_name, ¶ms, num_sockets, net_log); | 213 pool->RequestSockets(group_name, ¶ms, num_sockets, net_log); |
195 } | 214 } |
196 | 215 |
197 } // namespace net | 216 } // namespace net |
198 | 217 |
199 #endif // NET_SOCKET_CLIENT_SOCKET_POOL_H_ | 218 #endif // NET_SOCKET_CLIENT_SOCKET_POOL_H_ |
OLD | NEW |