third_party/WebKit/public/platform/WebURLLoader.h

   1 /*
   2  * Copyright (C) 2009, 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebURLLoader_h
  32 #define WebURLLoader_h
  33
  34 #include "WebCommon.h"
  35 #include "WebURLRequest.h"
  36
  37 namespace blink {
  38
  39 class WebData;
  40 class WebThreadedDataReceiver;
  41 class WebURLLoaderClient;
  42 class WebURLResponse;
  43 struct WebURLError;
  44
  45 class WebURLLoader {
  46 public:
  47     // The WebURLLoader may be deleted in a call to its client.
  48     virtual ~WebURLLoader() {}
  49
  50     // Load the request synchronously, returning results directly to the
  51     // caller upon completion.  There is no mechanism to interrupt a
  52     // synchronous load!!
  53     virtual void loadSynchronously(const WebURLRequest&,
  54         WebURLResponse&, WebURLError&, WebData& data) = 0;
  55
  56     // Load the request asynchronously, sending notifications to the given
  57     // client.  The client will receive no further notifications if the
  58     // loader is disposed before it completes its work.
  59     virtual void loadAsynchronously(const WebURLRequest&,
  60         WebURLLoaderClient*) = 0;
  61
  62     // Cancels an asynchronous load.  This will appear as a load error to
  63     // the client.
  64     virtual void cancel() = 0;
  65
  66     // Suspends/resumes an asynchronous load.
  67     virtual void setDefersLoading(bool) = 0;
  68
  69     // Notifies the loader that the priority of a WebURLRequest has changed from
  70     // its previous value. For example, a preload request starts with low
  71     // priority, but may increase when the resource is needed for rendering.
  72     virtual void didChangePriority(WebURLRequest::Priority newPriority) { }
  73     virtual void didChangePriority(WebURLRequest::Priority newPriority, int intraPriorityValue) { didChangePriority(newPriority); }
  74
  75     // Try to attach the given data receiver which from this point will receive data
  76     // on its thread (provided by WebThreadedDataReceiver::backgroundThread(),
  77     // rather than the WebURLLoaderClient. If successful, ownership
  78     // of the data receiver is assumed by the WebURLLoader and the receiver should
  79     // be deleted on the main thread when no longer needed.
  80     virtual bool attachThreadedDataReceiver(WebThreadedDataReceiver*) { return false; }
  81 };
  82
  83 } // namespace blink
  84
  85 #endif