components/cronet/android/cronet_url_request_adapter.h

   1 // Copyright 2014 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 COMPONENTS_CRONET_ANDROID_CRONET_URL_REQUEST_ADAPTER_H_
   6 #define COMPONENTS_CRONET_ANDROID_CRONET_URL_REQUEST_ADAPTER_H_
   7
   8 #include <string>
   9
  10 #include "base/callback.h"
  11 #include "base/location.h"
  12 #include "base/macros.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "net/base/request_priority.h"
  15 #include "net/http/http_request_headers.h"
  16 #include "net/url_request/url_request.h"
  17 #include "url/gurl.h"
  18
  19 namespace base {
  20 class SingleThreadTaskRunner;
  21 }  // namespace base
  22
  23 namespace net {
  24 class GrowableIOBuffer;
  25 class HttpResponseHeaders;
  26 class UploadDataStream;
  27 }  // namespace net
  28
  29 namespace cronet {
  30
  31 class CronetURLRequestContextAdapter;
  32
  33 // An adapter from the JNI CronetUrlRequest object to the Chromium URLRequest.
  34 // Created and configured from random thread. Start is posted to network
  35 // thread and all callbacks into CronetURLRequestAdapterDelegate are done on
  36 // network thread. Each delegate callback is expected to initiate next step like
  37 // FollowDeferredRedirect, ReadData or Destroy. All methods except those needed
  38 // to set up a request must be called exclusively on the network thread.
  39 class CronetURLRequestAdapter : public net::URLRequest::Delegate {
  40  public:
  41   // The delegate which is called when the request adapter completes a step.
  42   // Always called on network thread.
  43   class CronetURLRequestAdapterDelegate {
  44    public:
  45     // Called on redirect. Consumer should either destroy the request, or
  46     // call FollowDeferredRedirect.
  47     virtual void OnRedirect(const GURL& newLocation, int http_status_code) = 0;
  48     // Called when response has started and headers have been received. Consumer
  49     // should either destroy the request, or call ReadData.
  50     virtual void OnResponseStarted(int http_status_code) = 0;
  51     // Called when response bytes were read. Consumer should consume data and
  52     // either destroy the request, or call ReadData. The request may only be
  53     // destroyed after the embedder is done with |bytes|, as deleting the
  54     // request frees the buffer.
  55     virtual void OnBytesRead(unsigned char* bytes,
  56                              int bytes_read) = 0;
  57     // Called when response has finished successfully. Consumer should destroy
  58     // the request.
  59     virtual void OnRequestFinished() = 0;
  60     // Called when response has finished with error. Consumer should destroy
  61     // the request.
  62     virtual void OnError(int net_error) = 0;
  63
  64     virtual ~CronetURLRequestAdapterDelegate() {}
  65   };
  66
  67   CronetURLRequestAdapter(
  68       CronetURLRequestContextAdapter* context,
  69       scoped_ptr<CronetURLRequestAdapterDelegate> delegate,
  70       const GURL& url,
  71       net::RequestPriority priority);
  72   ~CronetURLRequestAdapter() override;
  73
  74   // Methods called prior to Start are never called on network thread.
  75
  76   // Sets the request method GET, POST etc.
  77   void set_method(const std::string& method) {
  78     initial_method_ = method;
  79   }
  80
  81   // Adds a header to the request before it starts.
  82   void AddRequestHeader(const std::string& name, const std::string& value);
  83
  84   // Adds a request body to the request before it starts.
  85   void SetUpload(scoped_ptr<net::UploadDataStream> upload);
  86
  87   // Methods called on any thread.
  88
  89   // Posts tasks to network thread.
  90   void PostTaskToNetworkThread(const tracked_objects::Location& from_here,
  91                                const base::Closure& task);
  92
  93   // Returns true if called on network thread.
  94   bool IsOnNetworkThread() const;
  95
  96   // Methods called only on network thread.
  97
  98   // Starts the request.
  99   void Start();
 100
 101   // Follows redirect.
 102   void FollowDeferredRedirect();
 103
 104   // Reads more data.
 105   void ReadData();
 106
 107   // Releases all resources for the request and deletes the object itself.
 108   void Destroy();
 109
 110   // When called during a OnRedirect or OnResponseStarted callback, these
 111   // methods return the corresponding response information.
 112
 113   // Gets all response headers, as a HttpResponseHeaders object. Returns NULL
 114   // if the last attempted request received no headers.
 115   const net::HttpResponseHeaders* GetResponseHeaders() const;
 116
 117   // Gets NPN or ALPN Negotiated Protocol (if any) from HttpResponseInfo.
 118   const std::string& GetNegotiatedProtocol() const;
 119
 120   // Returns true if response is coming from the cache.
 121   bool GetWasCached() const;
 122
 123   // Gets the total amount of body data received from network after
 124   // SSL/SPDY/QUIC decoding and proxy handling.  Basically the size of the body
 125   // prior to decompression.
 126   int64 GetTotalReceivedBytes() const;
 127
 128   // Bypasses cache. If context is not set up to use cache, this call has no
 129   // effect.
 130   void DisableCache();
 131
 132   // net::URLRequest::Delegate overrides.
 133   void OnReceivedRedirect(net::URLRequest* request,
 134                           const net::RedirectInfo& redirect_info,
 135                           bool* defer_redirect) override;
 136   void OnResponseStarted(net::URLRequest* request) override;
 137   void OnReadCompleted(net::URLRequest* request, int bytes_read) override;
 138
 139  private:
 140   // Checks status of the request_adapter, return false if |is_success()| is
 141   // true, otherwise report error and cancel request_adapter.
 142   bool MaybeReportError(net::URLRequest* request) const;
 143
 144   CronetURLRequestContextAdapter* context_;
 145   scoped_ptr<CronetURLRequestAdapterDelegate> delegate_;
 146
 147   const GURL initial_url_;
 148   const net::RequestPriority initial_priority_;
 149   std::string initial_method_;
 150   int load_flags_;
 151   net::HttpRequestHeaders initial_request_headers_;
 152   scoped_ptr<net::UploadDataStream> upload_;
 153
 154   scoped_refptr<net::IOBufferWithSize> read_buffer_;
 155   scoped_ptr<net::URLRequest> url_request_;
 156
 157   DISALLOW_COPY_AND_ASSIGN(CronetURLRequestAdapter);
 158 };
 159
 160 }  // namespace cronet
 161
 162 #endif  // COMPONENTS_CRONET_ANDROID_CRONET_URL_REQUEST_ADAPTER_H_