Home | History | Annotate | Download | only in renderer 
      1 // Copyright 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 CONTENT_PUBLIC_RENDERER_RESOURCE_FETCHER_H_
      6 #define CONTENT_PUBLIC_RENDERER_RESOURCE_FETCHER_H_
      7 
      8 #include <string>
      9 
     10 #include "base/callback.h"
     11 #include "content/common/content_export.h"
     12 #include "third_party/WebKit/public/platform/WebURLRequest.h"
     13 
     14 class GURL;
     15 
     16 namespace base {
     17 class TimeDelta;
     18 }
     19 
     20 namespace blink {
     21 class WebFrame;
     22 class WebURLResponse;
     23 }
     24 
     25 namespace content {
     26 
     27 // Interface to download resources asynchronously.
     28 class CONTENT_EXPORT ResourceFetcher {
     29  public:
     30   enum LoaderType {
     31     PLATFORM_LOADER,         // uses Platform::createURLLoader
     32     FRAME_ASSOCIATED_LOADER, // uses WebFrame::createAssociatedURLLoader
     33   };
     34 
     35   virtual ~ResourceFetcher() {}
     36 
     37   // This will be called asynchronously after the URL has been fetched,
     38   // successfully or not.  If there is a failure, response and data will both be
     39   // empty.  |response| and |data| are both valid until the URLFetcher instance
     40   // is destroyed.
     41   typedef base::Callback<void(const blink::WebURLResponse& response,
     42                               const std::string& data)> Callback;
     43 
     44   // Creates a ResourceFetcher for the specified resource.  Caller takes
     45   // ownership of the returned object.  Deleting the ResourceFetcher will cancel
     46   // the request, and the callback will never be run.
     47   static ResourceFetcher* Create(const GURL& url);
     48 
     49   // Set the corresponding parameters of the request.  Must be called before
     50   // Start.  By default, requests are GETs with no body.
     51   virtual void SetMethod(const std::string& method) = 0;
     52   virtual void SetBody(const std::string& body) = 0;
     53   virtual void SetHeader(const std::string& header,
     54                          const std::string& value) = 0;
     55 
     56   // Starts the request using the specified frame.  Calls |callback| when
     57   // done.
     58   virtual void Start(blink::WebFrame* frame,
     59                      blink::WebURLRequest::RequestContext request_context,
     60                      blink::WebURLRequest::FrameType frame_type,
     61                      LoaderType loader_type,
     62                      const Callback& callback) = 0;
     63 
     64   // Sets how long to wait for the server to reply.  By default, there is no
     65   // timeout.  Must be called after a request is started.
     66   virtual void SetTimeout(const base::TimeDelta& timeout) = 0;
     67 
     68   // Manually cancel the request.
     69   virtual void Cancel() = 0;
     70 };
     71 
     72 }  // namespace content
     73 
     74 #endif  // CONTENT_PUBLIC_RENDERER_RESOURCE_FETCHER_H_
     75