diff options
Diffstat (limited to 'chromium/net/proxy/proxy_resolver.h')
-rw-r--r-- | chromium/net/proxy/proxy_resolver.h | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/chromium/net/proxy/proxy_resolver.h b/chromium/net/proxy/proxy_resolver.h new file mode 100644 index 00000000000..47ec31af5c6 --- /dev/null +++ b/chromium/net/proxy/proxy_resolver.h @@ -0,0 +1,83 @@ +// 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. + +#ifndef NET_PROXY_PROXY_RESOLVER_H_ +#define NET_PROXY_PROXY_RESOLVER_H_ + +#include "base/logging.h" +#include "base/memory/ref_counted.h" +#include "base/strings/string16.h" +#include "net/base/completion_callback.h" +#include "net/base/load_states.h" +#include "net/base/net_export.h" +#include "net/proxy/proxy_resolver_script_data.h" +#include "url/gurl.h" + +namespace net { + +class BoundNetLog; +class ProxyInfo; + +// Interface for "proxy resolvers". A ProxyResolver fills in a list of proxies +// to use for a particular URL. Generally the backend for a ProxyResolver is +// a PAC script, but it doesn't need to be. ProxyResolver can service multiple +// requests at a time. +class NET_EXPORT_PRIVATE ProxyResolver { + public: + // Opaque pointer type, to return a handle to cancel outstanding requests. + typedef void* RequestHandle; + + // See |expects_pac_bytes()| for the meaning of |expects_pac_bytes|. + explicit ProxyResolver(bool expects_pac_bytes) + : expects_pac_bytes_(expects_pac_bytes) {} + + virtual ~ProxyResolver() {} + + // Gets a list of proxy servers to use for |url|. If the request will + // complete asynchronously returns ERR_IO_PENDING and notifies the result + // by running |callback|. If the result code is OK then + // the request was successful and |results| contains the proxy + // resolution information. In the case of asynchronous completion + // |*request| is written to, and can be passed to CancelRequest(). + virtual int GetProxyForURL(const GURL& url, + ProxyInfo* results, + const net::CompletionCallback& callback, + RequestHandle* request, + const BoundNetLog& net_log) = 0; + + // Cancels |request|. + virtual void CancelRequest(RequestHandle request) = 0; + + // Gets the LoadState for |request|. + virtual LoadState GetLoadState(RequestHandle request) const = 0; + + // The PAC script backend can be specified to the ProxyResolver either via + // URL, or via the javascript text itself. If |expects_pac_bytes| is true, + // then the ProxyResolverScriptData passed to SetPacScript() should + // contain the actual script bytes rather than just the URL. + bool expects_pac_bytes() const { return expects_pac_bytes_; } + + virtual void CancelSetPacScript() = 0; + + // Frees any unneeded memory held by the resolver, e.g. garbage in the JS + // engine. Most subclasses don't need to do anything, so we provide a default + // no-op implementation. + virtual void PurgeMemory() {} + + // Called to set the PAC script backend to use. + // Returns ERR_IO_PENDING in the case of asynchronous completion, and notifies + // the result through |callback|. + virtual int SetPacScript( + const scoped_refptr<ProxyResolverScriptData>& pac_script, + const net::CompletionCallback& callback) = 0; + + private: + const bool expects_pac_bytes_; + + DISALLOW_COPY_AND_ASSIGN(ProxyResolver); +}; + +} // namespace net + +#endif // NET_PROXY_PROXY_RESOLVER_H_ |