1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// This is the browser side of the resource dispatcher, it receives requests
// from the RenderProcessHosts, and dispatches them to URLRequests. It then
// fowards the messages from the URLRequests back to the correct process for
// handling.
//
// See http://dev.chromium.org/developers/design-documents/multi-process-resource-loading
#ifndef CHROME_BROWSER_RENDERER_HOST_RESOURCE_HANDLER_H_
#define CHROME_BROWSER_RENDERER_HOST_RESOURCE_HANDLER_H_
#include <string>
#include "build/build_config.h"
#if defined(OS_POSIX)
#include "base/file_descriptor_posix.h"
#endif
#include "base/platform_file.h"
#include "chrome/common/filter_policy.h"
#include "net/url_request/url_request_status.h"
#include "webkit/glue/resource_loader_bridge.h"
namespace net {
class IOBuffer;
}
// Parameters for a resource response header.
struct ResourceResponseHead
: webkit_glue::ResourceLoaderBridge::ResponseInfo {
// The response status.
URLRequestStatus status;
// Specifies if the resource should be filtered before being displayed
// (insecure resources can be filtered to keep the page secure).
FilterPolicy::Type filter_policy;
// A platform specific handle for a file that carries response data. This
// entry is used if the resource request is of type ResourceType::MEDIA and
// the underlying cache layer keeps the response data in a standalone file.
#if defined(OS_POSIX)
// If the response data file is available, the file handle is stored in
// response_data_file.fd, its value is base::kInvalidPlatformFileValue
// otherwise.
base::FileDescriptor response_data_file;
#elif defined(OS_WIN)
// An asynchronous file handle to the response data file, its value is
// base::kInvalidPlatformFileValue if the file is not available.
base::PlatformFile response_data_file;
#endif
};
// Parameters for a synchronous resource response.
struct SyncLoadResult : ResourceResponseHead {
// The final URL after any redirects.
GURL final_url;
// The response data.
std::string data;
};
// Simple wrapper that refcounts ResourceResponseHead.
struct ResourceResponse : public base::RefCounted<ResourceResponse> {
ResourceResponseHead response_head;
};
// The resource dispatcher host uses this interface to push load events to the
// renderer, allowing for differences in the types of IPC messages generated.
// See the implementations of this interface defined below.
class ResourceHandler : public base::RefCounted<ResourceHandler> {
public:
virtual ~ResourceHandler() {}
// Called as upload progress is made.
virtual bool OnUploadProgress(int request_id,
uint64 position,
uint64 size) {
return true;
}
// The request was redirected to a new URL.
virtual bool OnRequestRedirected(int request_id, const GURL& url) = 0;
// Response headers and meta data are available.
virtual bool OnResponseStarted(int request_id,
ResourceResponse* response) = 0;
// Data will be read for the response. Upon success, this method places the
// size and address of the buffer where the data is to be written in its
// out-params. This call will be followed by either OnReadCompleted or
// OnResponseCompleted, at which point the buffer may be recycled.
virtual bool OnWillRead(int request_id,
net::IOBuffer** buf,
int* buf_size,
int min_size) = 0;
// Data (*bytes_read bytes) was written into the buffer provided by
// OnWillRead. A return value of false cancels the request, true continues
// reading data.
virtual bool OnReadCompleted(int request_id, int* bytes_read) = 0;
// The response is complete. The final response status is given.
// Returns false if the handler is deferring the call to a later time.
virtual bool OnResponseCompleted(int request_id,
const URLRequestStatus& status,
const std::string& security_info) = 0;
};
#endif // CHROME_BROWSER_RENDERER_HOST_RESOURCE_HANDLER_H_
|
