15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_PROXY_PROXY_RESOLVER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_PROXY_PROXY_RESOLVER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 105e3f23d412006dc4db4e659864679f29341e113fTorne (Richard Coles)#include "base/strings/string16.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/completion_callback.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/load_states.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/proxy/proxy_resolver_script_data.h" 157dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#include "url/gurl.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BoundNetLog; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ProxyInfo; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Interface for "proxy resolvers". A ProxyResolver fills in a list of proxies 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to use for a particular URL. Generally the backend for a ProxyResolver is 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// a PAC script, but it doesn't need to be. ProxyResolver can service multiple 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// requests at a time. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE ProxyResolver { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Opaque pointer type, to return a handle to cancel outstanding requests. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef void* RequestHandle; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // See |expects_pac_bytes()| for the meaning of |expects_pac_bytes|. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit ProxyResolver(bool expects_pac_bytes) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : expects_pac_bytes_(expects_pac_bytes) {} 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ProxyResolver() {} 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets a list of proxy servers to use for |url|. If the request will 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // complete asynchronously returns ERR_IO_PENDING and notifies the result 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // by running |callback|. If the result code is OK then 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the request was successful and |results| contains the proxy 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // resolution information. In the case of asynchronous completion 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |*request| is written to, and can be passed to CancelRequest(). 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int GetProxyForURL(const GURL& url, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProxyInfo* results, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RequestHandle* request, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BoundNetLog& net_log) = 0; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Cancels |request|. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CancelRequest(RequestHandle request) = 0; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the LoadState for |request|. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual LoadState GetLoadState(RequestHandle request) const = 0; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The PAC script backend can be specified to the ProxyResolver either via 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // URL, or via the javascript text itself. If |expects_pac_bytes| is true, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // then the ProxyResolverScriptData passed to SetPacScript() should 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // contain the actual script bytes rather than just the URL. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool expects_pac_bytes() const { return expects_pac_bytes_; } 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CancelSetPacScript() = 0; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called to set the PAC script backend to use. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns ERR_IO_PENDING in the case of asynchronous completion, and notifies 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the result through |callback|. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int SetPacScript( 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const scoped_refptr<ProxyResolverScriptData>& pac_script, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback) = 0; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const bool expects_pac_bytes_; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ProxyResolver); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_PROXY_PROXY_RESOLVER_H_ 79