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