net/url_request/url_fetcher_impl.h

   1 // Copyright (c) 2012 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 // This file contains URLFetcher, a wrapper around URLRequest that handles
   6 // low-level details like thread safety, ref counting, and incremental buffer
   7 // reading.  This is useful for callers who simply want to get the data from a
   8 // URL and don't care about all the nitty-gritty details.
   9 //
  10 // NOTE(willchan): Only one "IO" thread is supported for URLFetcher.  This is a
  11 // temporary situation.  We will work on allowing support for multiple "io"
  12 // threads per process.
  13
  14 #ifndef NET_URL_REQUEST_URL_FETCHER_IMPL_H_
  15 #define NET_URL_REQUEST_URL_FETCHER_IMPL_H_
  16
  17 #include "base/basictypes.h"
  18 #include "base/compiler_specific.h"
  19 #include "net/base/net_export.h"
  20 #include "net/url_request/url_fetcher.h"
  21
  22 namespace net {
  23 class URLFetcherCore;
  24 class URLFetcherDelegate;
  25 class URLFetcherFactory;
  26
  27 class NET_EXPORT_PRIVATE URLFetcherImpl : public URLFetcher {
  28  public:
  29   // |url| is the URL to send the request to.
  30   // |request_type| is the type of request to make.
  31   // |d| the object that will receive the callback on fetch completion.
  32   URLFetcherImpl(const GURL& url,
  33                  RequestType request_type,
  34                  URLFetcherDelegate* d);
  35   virtual ~URLFetcherImpl();
  36
  37   // URLFetcher implementation:
  38   virtual void SetUploadData(const std::string& upload_content_type,
  39                              const std::string& upload_content) OVERRIDE;
  40   virtual void SetChunkedUpload(
  41       const std::string& upload_content_type) OVERRIDE;
  42   virtual void AppendChunkToUpload(const std::string& data,
  43                                    bool is_last_chunk) OVERRIDE;
  44   virtual void SetLoadFlags(int load_flags) OVERRIDE;
  45   virtual int GetLoadFlags() const OVERRIDE;
  46   virtual void SetReferrer(const std::string& referrer) OVERRIDE;
  47   virtual void SetExtraRequestHeaders(
  48       const std::string& extra_request_headers) OVERRIDE;
  49   virtual void AddExtraRequestHeader(const std::string& header_line) OVERRIDE;
  50   virtual void GetExtraRequestHeaders(
  51       HttpRequestHeaders* headers) const OVERRIDE;
  52   virtual void SetRequestContext(
  53       URLRequestContextGetter* request_context_getter) OVERRIDE;
  54   virtual void SetFirstPartyForCookies(
  55       const GURL& first_party_for_cookies) OVERRIDE;
  56   virtual void SetURLRequestUserData(
  57       const void* key,
  58       const CreateDataCallback& create_data_callback) OVERRIDE;
  59   virtual void SetStopOnRedirect(bool stop_on_redirect) OVERRIDE;
  60   virtual void SetAutomaticallyRetryOn5xx(bool retry) OVERRIDE;
  61   virtual void SetMaxRetriesOn5xx(int max_retries) OVERRIDE;
  62   virtual int GetMaxRetriesOn5xx() const OVERRIDE;
  63   virtual base::TimeDelta GetBackoffDelay() const OVERRIDE;
  64   virtual void SetAutomaticallyRetryOnNetworkChanges(int max_retries) OVERRIDE;
  65   virtual void SaveResponseToFileAtPath(
  66       const base::FilePath& file_path,
  67       scoped_refptr<base::TaskRunner> file_task_runner) OVERRIDE;
  68   virtual void SaveResponseToTemporaryFile(
  69       scoped_refptr<base::TaskRunner> file_task_runner) OVERRIDE;
  70   virtual HttpResponseHeaders* GetResponseHeaders() const OVERRIDE;
  71   virtual HostPortPair GetSocketAddress() const OVERRIDE;
  72   virtual bool WasFetchedViaProxy() const OVERRIDE;
  73   virtual void Start() OVERRIDE;
  74   virtual const GURL& GetOriginalURL() const OVERRIDE;
  75   virtual const GURL& GetURL() const OVERRIDE;
  76   virtual const URLRequestStatus& GetStatus() const OVERRIDE;
  77   virtual int GetResponseCode() const OVERRIDE;
  78   virtual const ResponseCookies& GetCookies() const OVERRIDE;
  79   virtual bool FileErrorOccurred(
  80       base::PlatformFileError* out_error_code) const OVERRIDE;
  81   virtual void ReceivedContentWasMalformed() OVERRIDE;
  82   virtual bool GetResponseAsString(
  83       std::string* out_response_string) const OVERRIDE;
  84   virtual bool GetResponseAsFilePath(
  85       bool take_ownership,
  86       base::FilePath* out_response_path) const OVERRIDE;
  87
  88   static void CancelAll();
  89
  90   static void SetEnableInterceptionForTests(bool enabled);
  91   static void SetIgnoreCertificateRequests(bool ignored);
  92
  93   // TODO(akalin): Make these private again once URLFetcher::Create()
  94   // is in net/.
  95
  96   static URLFetcherFactory* factory();
  97
  98   // Sets the factory used by the static method Create to create a URLFetcher.
  99   // URLFetcher does not take ownership of |factory|. A value of NULL results
 100   // in a URLFetcher being created directly.
 101   //
 102   // NOTE: for safety, this should only be used through ScopedURLFetcherFactory!
 103   static void set_factory(URLFetcherFactory* factory);
 104
 105  protected:
 106   // Returns the delegate.
 107   URLFetcherDelegate* delegate() const;
 108
 109  private:
 110   friend class URLFetcherTest;
 111
 112   // Only used by URLFetcherTest, returns the number of URLFetcher::Core objects
 113   // actively running.
 114   static int GetNumFetcherCores();
 115
 116   const scoped_refptr<URLFetcherCore> core_;
 117
 118   DISALLOW_COPY_AND_ASSIGN(URLFetcherImpl);
 119 };
 120
 121 }  // namespace net
 122
 123 #endif  // NET_URL_REQUEST_URL_FETCHER_IMPL_H_