resolve_proxy_msg_helper.h revision ddb351dbec246cf1fab5ec20d2d5520909041de1 
1// Copyright (c) 2011 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 CHROME_BROWSER_NET_RESOLVE_PROXY_MSG_HELPER_H_
6#define CHROME_BROWSER_NET_RESOLVE_PROXY_MSG_HELPER_H_
7#pragma once
8
9#include <deque>
10#include <string>
11
12#include "base/memory/ref_counted.h"
13#include "content/browser/browser_message_filter.h"
14#include "googleurl/src/gurl.h"
15#include "net/base/completion_callback.h"
16#include "net/proxy/proxy_service.h"
17
18// Responds to ChildProcessHostMsg_ResolveProxy, kicking off a ProxyResolve
19// request on the IO thread using the specified proxy service.  Completion is
20// notified through the delegate.  If multiple requests are started at the same
21// time, they will run in FIFO order, with only 1 being outstanding at a time.
22//
23// When an instance of ResolveProxyMsgHelper is destroyed, it cancels any
24// outstanding proxy resolve requests with the proxy service. It also deletes
25// the stored IPC::Message pointers for pending requests.
26//
27// This object is expected to live on the IO thread.
28class ResolveProxyMsgHelper : public BrowserMessageFilter {
29 public:
30  // If |proxy_service| is NULL, then the main profile's proxy service will
31  // be used.
32  explicit ResolveProxyMsgHelper(net::ProxyService* proxy_service);
33
34  // Destruction cancels the current outstanding request, and clears the
35  // pending queue.
36  ~ResolveProxyMsgHelper();
37
38  // BrowserMessageFilter implementation
39  virtual bool OnMessageReceived(const IPC::Message& message,
40                                 bool* message_was_ok);
41
42  void OnResolveProxy(const GURL& url, IPC::Message* reply_msg);
43
44 private:
45  // Callback for the ProxyService (bound to |callback_|).
46  void OnResolveProxyCompleted(int result);
47
48  // Starts the first pending request.
49  void StartPendingRequest();
50
51  // Get the proxy service instance to use. On success returns true and
52  // sets |*out|. Otherwise returns false.
53  bool GetProxyService(scoped_refptr<net::ProxyService>* out) const;
54
55  // A PendingRequest is a resolve request that is in progress, or queued.
56  struct PendingRequest {
57   public:
58     PendingRequest(const GURL& url, IPC::Message* reply_msg) :
59         url(url), reply_msg(reply_msg), pac_req(NULL) { }
60
61     // The URL of the request.
62     GURL url;
63
64     // Data to pass back to the delegate on completion (we own it until then).
65     IPC::Message* reply_msg;
66
67     // Handle for cancelling the current request if it has started (else NULL).
68     net::ProxyService::PacRequest* pac_req;
69  };
70
71  // Members for the current outstanding proxy request.
72  scoped_refptr<net::ProxyService> proxy_service_;
73  net::CompletionCallbackImpl<ResolveProxyMsgHelper> callback_;
74  net::ProxyInfo proxy_info_;
75
76  // FIFO queue of pending requests. The first entry is always the current one.
77  typedef std::deque<PendingRequest> PendingRequestList;
78  PendingRequestList pending_requests_;
79
80  // Specified by unit-tests, to use this proxy service in place of the
81  // global one.
82  scoped_refptr<net::ProxyService> proxy_service_override_;
83};
84
85#endif  // CHROME_BROWSER_NET_RESOLVE_PROXY_MSG_HELPER_H_
86