1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef NET_PROXY_PROXY_LIST_H_
6 #define NET_PROXY_PROXY_LIST_H_
11 #include "net/base/net_export.h"
12 #include "net/base/net_log.h"
13 #include "net/proxy/proxy_retry_info.h"
24 // This class is used to hold a list of proxies returned by GetProxyForUrl or
25 // manually configured. It handles proxy fallback if multiple servers are
27 class NET_EXPORT_PRIVATE ProxyList {
32 // Initializes the proxy list to a string containing one or more proxy servers
33 // delimited by a semicolon.
34 void Set(const std::string& proxy_uri_list);
36 // Set the proxy list to a single entry, |proxy_server|.
37 void SetSingleProxyServer(const ProxyServer& proxy_server);
39 // Append a single proxy server to the end of the proxy list.
40 void AddProxyServer(const ProxyServer& proxy_server);
42 // De-prioritizes the proxies that are cached as not working but are allowed
43 // to be reconsidered, by moving them to the end of the fallback list.
44 void DeprioritizeBadProxies(const ProxyRetryInfoMap& proxy_retry_info);
46 // Delete any entry which doesn't have one of the specified proxy schemes.
47 // |scheme_bit_field| is a bunch of ProxyServer::Scheme bitwise ORed together.
48 void RemoveProxiesWithoutScheme(int scheme_bit_field);
50 // Clear the proxy list.
53 // Returns true if there is nothing left in the ProxyList.
56 // Returns the number of proxy servers in this list.
59 // Returns true if |*this| lists the same proxies as |other|.
60 bool Equals(const ProxyList& other) const;
62 // Returns the first proxy server in the list. It is only valid to call
63 // this if !IsEmpty().
64 const ProxyServer& Get() const;
66 // Sets the list by parsing the pac result |pac_string|.
67 // Some examples for |pac_string|:
70 // "PROXY foopy1; SOCKS4 foopy2:1188"
71 // Does a best-effort parse, and silently discards any errors.
72 void SetFromPacString(const std::string& pac_string);
74 // Returns a PAC-style semicolon-separated list of valid proxy servers.
75 // For example: "PROXY xxx.xxx.xxx.xxx:xx; SOCKS yyy.yyy.yyy:yy".
76 std::string ToPacString() const;
78 // Returns a serialized value for the list. The caller takes ownership of it.
79 base::ListValue* ToValue() const;
81 // Marks the current proxy server as bad and deletes it from the list. The
82 // list of known bad proxies is given by proxy_retry_info. Returns true if
83 // there is another server available in the list.
84 bool Fallback(ProxyRetryInfoMap* proxy_retry_info,
85 const BoundNetLog& net_log);
87 // Updates |proxy_retry_info| to indicate that the first proxy in the list
88 // is bad. This is distinct from Fallback(), above, to allow updating proxy
89 // retry information without modifying a given transction's proxy list. Will
90 // retry after |retry_delay| if positive, and will use the default proxy retry
91 // duration otherwise. It may reconsider the proxy beforehand if |reconsider|
92 // is true. Additionally updates |proxy_retry_info| with
93 // |another_proxy_to_bypass| if non-empty.
94 void UpdateRetryInfoOnFallback(
95 ProxyRetryInfoMap* proxy_retry_info,
96 base::TimeDelta retry_delay,
98 const ProxyServer& another_proxy_to_bypass,
99 const BoundNetLog& net_log) const;
102 // Updates |proxy_retry_info| to indicate that the |proxy_to_retry| in
103 // |proxies_| is bad for |retry_delay|, but may be reconsidered earlier if
104 // |try_while_bad| is true.
105 void AddProxyToRetryList(ProxyRetryInfoMap* proxy_retry_info,
106 base::TimeDelta retry_delay,
108 const ProxyServer& proxy_to_retry,
109 const BoundNetLog& net_log) const;
112 std::vector<ProxyServer> proxies_;
117 #endif // NET_PROXY_PROXY_LIST_H_