third_party/WebKit/public/platform/WebURLLoaderClient.h

   1 /*
   2  * Copyright (C) 2009 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 WebURLLoaderClient_h
  32 #define WebURLLoaderClient_h
  33
  34 #include "public/platform/WebCommon.h"
  35 #include "public/platform/WebDataConsumerHandle.h"
  36
  37 namespace blink {
  38
  39 class WebURLLoader;
  40 class WebURLRequest;
  41 class WebURLResponse;
  42 struct WebURLError;
  43
  44 class BLINK_PLATFORM_EXPORT WebURLLoaderClient {
  45 public:
  46     // Called when following a redirect. |newRequest| contains the request
  47     // generated by the redirect. The client may modify |newRequest|.
  48     virtual void willSendRequest(
  49         WebURLLoader*, WebURLRequest& newRequest, const WebURLResponse& redirectResponse) { }
  50
  51     // Called to report upload progress. The bytes reported correspond to
  52     // the HTTP message body.
  53     virtual void didSendData(
  54         WebURLLoader*, unsigned long long bytesSent, unsigned long long totalBytesToBeSent) { }
  55
  56     // Called when response headers are received.
  57     virtual void didReceiveResponse(WebURLLoader*, const WebURLResponse&) { }
  58
  59     // Called when response headers are received.
  60     // The ownership of |handle| is transferred to the callee.
  61     virtual void didReceiveResponse(WebURLLoader* loader, const WebURLResponse& response, WebDataConsumerHandle* handle)
  62     {
  63         delete handle;
  64         didReceiveResponse(loader, response);
  65     }
  66
  67     // Called when a chunk of response data is downloaded. This is only called
  68     // if WebURLRequest's downloadToFile flag was set to true.
  69     virtual void didDownloadData(WebURLLoader*, int dataLength, int encodedDataLength) { }
  70
  71     // Called when a chunk of response data is received.
  72     virtual void didReceiveData(WebURLLoader*, const char* data, int dataLength, int encodedDataLength) { }
  73
  74     // Called when a chunk of renderer-generated metadata is received from the cache.
  75     virtual void didReceiveCachedMetadata(WebURLLoader*, const char* data, int dataLength) { }
  76
  77     // Called when the load completes successfully.
  78     // |totalEncodedDataLength| may be equal to kUnknownEncodedDataLength.
  79     virtual void didFinishLoading(WebURLLoader* loader, double finishTime, int64_t totalEncodedDataLength) { }
  80
  81     // Called when the load completes with an error.
  82     virtual void didFail(WebURLLoader*, const WebURLError&) { }
  83
  84     // Value passed to didFinishLoading when total encoded data length isn't known.
  85     static const int64_t kUnknownEncodedDataLength = -1;
  86
  87 protected:
  88     virtual ~WebURLLoaderClient() { }
  89 };
  90
  91 } // namespace blink
  92
  93 #endif