1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_BASE_PROXY_DELEGATE_H_
#define NET_BASE_PROXY_DELEGATE_H_
#include <string>
#include "net/base/net_errors.h"
#include "net/base/net_export.h"
#include "net/base/network_anonymization_key.h"
#include "net/base/proxy_chain.h"
#include "net/proxy_resolution/proxy_retry_info.h"
class GURL;
namespace net {
class HttpRequestHeaders;
class HttpResponseHeaders;
class ProxyInfo;
class ProxyResolutionService;
// Delegate for setting up a connection.
class NET_EXPORT ProxyDelegate {
public:
ProxyDelegate() = default;
ProxyDelegate(const ProxyDelegate&) = delete;
ProxyDelegate& operator=(const ProxyDelegate&) = delete;
virtual ~ProxyDelegate() = default;
// Called as the proxy is being resolved for |url| for a |method| request.
// The caller may pass an empty string to get method agnostic resoulution.
// Allows the delegate to override the proxy resolution decision made by
// ProxyResolutionService. The delegate may override the decision by modifying
// the ProxyInfo |result|.
virtual void OnResolveProxy(
const GURL& url,
const NetworkAnonymizationKey& network_anonymization_key,
const std::string& method,
const ProxyRetryInfoMap& proxy_retry_info,
ProxyInfo* result) = 0;
// Called when use of a proxy chain failed due to `net_error`, but another
// proxy chain in the list succeeded. The failed proxy is within `bad_chain`,
// but it is undefined at which proxy in that chain. `net_error` is the
// network error encountered, if any, and OK if the fallback was for a reason
// other than a network error (e.g. the proxy service was explicitly directed
// to skip a proxy).
//
// This method is called for each bad chain in the proxy list after a request
// has ultimately been successful. If the request fails for all proxies in the
// list, this method will not be called.
virtual void OnFallback(const ProxyChain& bad_chain, int net_error) = 0;
// Called when a request is successful after failing with one or more proxy
// chains in the list. This is called before OnFallback is called for each new
// failing proxy chain.
virtual void OnSuccessfulRequestAfterFailures(
const ProxyRetryInfoMap& proxy_retry_info) = 0;
// Called immediately before a proxy tunnel request is sent. Provides the
// embedder an opportunity to add extra request headers. Returning any value
// other than OK will cause the connection to fail with that error.
virtual Error OnBeforeTunnelRequest(const ProxyChain& proxy_chain,
size_t chain_index,
HttpRequestHeaders* extra_headers) = 0;
// Called when the response headers for the proxy tunnel request have been
// received. Allows the delegate to override the net error code of the tunnel
// request. Returning OK causes the standard tunnel response handling to be
// performed. Implementations should make sure they can trust the proxy server
// at position `chain_index` in `proxy_chain` before making decisions based on
// `response_headers`.
virtual Error OnTunnelHeadersReceived(
const ProxyChain& proxy_chain,
size_t chain_index,
const HttpResponseHeaders& response_headers) = 0;
// Associates a `ProxyResolutionService` with this `ProxyDelegate`.
// `proxy_resolution_service` must outlive `this`.
virtual void SetProxyResolutionService(
ProxyResolutionService* proxy_resolution_service) = 0;
// Checks DNS aliases returned during host resolution against the MDL
// (Masked Domain List) manager to determine if any alias points to a
// third-party resource. If method returns true and
// `fail_if_alias_requires_proxy_override_` is set for connection request, the
// stream creation will be canceled with `ERR_PROXY_REQUIRED`, prompting a
// subsequent call to `OnResolveProxy`.
virtual bool AliasRequiresProxyOverride(
const std::string scheme,
const std::vector<std::string>& dns_aliases,
const net::NetworkAnonymizationKey& network_anonymization_key) = 0;
};
} // namespace net
#endif // NET_BASE_PROXY_DELEGATE_H_
|
