net/proxy/proxy_resolver_v8_tracing.h

   1 // Copyright (c) 2013 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.
   4
   5 #ifndef NET_PROXY_PROXY_RESOLVER_V8_TRACING_H_
   6 #define NET_PROXY_PROXY_RESOLVER_V8_TRACING_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "net/base/net_export.h"
  12 #include "net/proxy/proxy_resolver.h"
  13 #include "net/proxy/proxy_resolver_factory.h"
  14
  15 namespace net {
  16
  17 class HostResolver;
  18
  19 // ProxyResolverV8Tracing is a non-blocking proxy resolver.
  20 class NET_EXPORT ProxyResolverV8Tracing {
  21  public:
  22   // Bindings is an interface used by ProxyResolverV8Tracing to delegate
  23   // per-request functionality. Each instance will be destroyed on the origin
  24   // thread of the ProxyResolverV8Tracing when the request completes or is
  25   // cancelled. All methods will be invoked from the origin thread.
  26   class Bindings {
  27    public:
  28     Bindings() {}
  29     virtual ~Bindings() {}
  30
  31     // Invoked in response to an alert() call by the PAC script.
  32     virtual void Alert(const base::string16& message) = 0;
  33
  34     // Invoked in response to an error in the PAC script.
  35     virtual void OnError(int line_number, const base::string16& message) = 0;
  36
  37     // Returns a HostResolver to use for DNS resolution.
  38     virtual HostResolver* GetHostResolver() = 0;
  39
  40     // Returns a BoundNetLog to be passed to the HostResolver returned by
  41     // GetHostResolver().
  42     virtual BoundNetLog GetBoundNetLog() = 0;
  43
  44    private:
  45     DISALLOW_COPY_AND_ASSIGN(Bindings);
  46   };
  47
  48   virtual ~ProxyResolverV8Tracing() {}
  49
  50   // Gets a list of proxy servers to use for |url|. This request always
  51   // runs asynchronously and notifies the result by running |callback|. If the
  52   // result code is OK then the request was successful and |results| contains
  53   // the proxy resolution information. If |request| is non-null, |*request| is
  54   // written to, and can be passed to CancelRequest().
  55   virtual void GetProxyForURL(const GURL& url,
  56                               ProxyInfo* results,
  57                               const CompletionCallback& callback,
  58                               ProxyResolver::RequestHandle* request,
  59                               scoped_ptr<Bindings> bindings) = 0;
  60
  61   // Cancels |request|.
  62   virtual void CancelRequest(ProxyResolver::RequestHandle request) = 0;
  63
  64   // Gets the LoadState for |request|.
  65   virtual LoadState GetLoadState(
  66       ProxyResolver::RequestHandle request) const = 0;
  67 };
  68
  69 // A factory for ProxyResolverV8Tracing instances. The default implementation,
  70 // returned by Create(), creates ProxyResolverV8Tracing instances that execute
  71 // ProxyResolverV8 on a single helper thread, and do some magic to avoid
  72 // blocking in DNS. For more details see the design document:
  73 // https://docs.google.com/a/google.com/document/d/16Ij5OcVnR3s0MH4Z5XkhI9VTPoMJdaBn9rKreAmGOdE/edit?pli=1
  74 class NET_EXPORT ProxyResolverV8TracingFactory {
  75  public:
  76   ProxyResolverV8TracingFactory() {}
  77   virtual ~ProxyResolverV8TracingFactory() = default;
  78
  79   virtual void CreateProxyResolverV8Tracing(
  80       const scoped_refptr<ProxyResolverScriptData>& pac_script,
  81       scoped_ptr<ProxyResolverV8Tracing::Bindings> bindings,
  82       scoped_ptr<ProxyResolverV8Tracing>* resolver,
  83       const CompletionCallback& callback,
  84       scoped_ptr<ProxyResolverFactory::Request>* request) = 0;
  85
  86   static scoped_ptr<ProxyResolverV8TracingFactory> Create();
  87
  88  private:
  89   DISALLOW_COPY_AND_ASSIGN(ProxyResolverV8TracingFactory);
  90 };
  91
  92 }  // namespace net
  93
  94 #endif  // NET_PROXY_PROXY_RESOLVER_V8_TRACING_H_