OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 module mojo; | 5 module mojo; |
6 | 6 |
7 import "network/public/interfaces/network_error.mojom"; | 7 import "mojo/public/interfaces/network/network_error.mojom"; |
8 | 8 import "mojo/public/interfaces/network/url_request.mojom"; |
9 struct URLRequest { | 9 import "mojo/public/interfaces/network/url_response.mojom"; |
10 // The URL to load. | |
11 string url; | |
12 | |
13 // The HTTP method if applicable. | |
14 string method = "GET"; | |
15 | |
16 // Additional HTTP request headers. | |
17 array<string>? headers; | |
18 | |
19 // The payload for the request body, represented as a concatenation of data | |
20 // streams. For HTTP requests, the method must be set to "POST" or "PUT". | |
21 array<handle<data_pipe_consumer>>? body; | |
22 | |
23 // The buffer size of the data pipe returned in URLResponse's |body| member. | |
24 // A value of 0 indicates that the default buffer size should be used. This | |
25 // value is just a suggestion. The URLLoader may choose to ignore this value. | |
26 uint32 response_body_buffer_size = 0; | |
27 | |
28 // If set to true, then redirects will be automatically followed. Otherwise, | |
29 // when a redirect is encounterd, FollowRedirect must be called to proceed. | |
30 bool auto_follow_redirects = false; | |
31 | |
32 // If set to true, then the HTTP request will bypass the local cache and will | |
33 // have a 'Cache-Control: nocache' header added in that causes any proxy | |
34 // servers to also not satisfy the request from their cache. This has the | |
35 // effect of forcing a full end-to-end fetch. | |
36 bool bypass_cache = false; | |
37 | |
38 // The referrer request header. | |
39 string? referrer; | |
40 }; | |
41 | |
42 struct URLResponse { | |
43 // If the response resulted in a network level error, this field will be set. | |
44 NetworkError? error; | |
45 | |
46 // The response body stream. Read from this data pipe to receive the bytes of | |
47 // response body. | |
48 handle<data_pipe_consumer>? body; | |
49 | |
50 // The final URL of the response, after redirects have been followed. | |
51 string? url; | |
52 | |
53 // The HTTP status code. 0 if not applicable. | |
54 uint32 status_code; | |
55 | |
56 // The HTTP status line. | |
57 string? status_line; | |
58 | |
59 // The HTTP response headers. | |
60 array<string>? headers; | |
61 | |
62 // The MIME type of the response body. | |
63 string? mime_type; | |
64 | |
65 // The character set of the response body. | |
66 string? charset; | |
67 | |
68 // These fields are set to non-NULL if this response corresponds to a | |
69 // redirect. Call the |FollowRedirect| method on the URLLoader instance to | |
70 // follow this redirect. | |
71 string? redirect_method; | |
72 string? redirect_url; | |
73 string? redirect_referrer; | |
74 }; | |
75 | 10 |
76 struct URLLoaderStatus { | 11 struct URLLoaderStatus { |
77 // If the loader has failed due to a network level error, this field will be | 12 // If the loader has failed due to a network level error, this field will be |
78 // set. | 13 // set. |
79 NetworkError? error; | 14 NetworkError? error; |
80 | 15 |
81 // Set to true if the URLLoader is still working. Set to false once an error | 16 // Set to true if the URLLoader is still working. Set to false once an error |
82 // is encountered or the response body is completely copied to the response | 17 // is encountered or the response body is completely copied to the response |
83 // body stream. | 18 // body stream. |
84 bool is_loading; | 19 bool is_loading; |
85 | 20 |
86 // TODO(darin): Add further details about the stages of loading (e.g., | 21 // TODO(darin): Add further details about the stages of loading (e.g., |
87 // "resolving host") that happen prior to receiving bytes. | 22 // "resolving host") that happen prior to receiving bytes. |
88 }; | 23 }; |
89 | 24 |
90 interface URLLoader { | 25 interface URLLoader { |
91 // Loads the given |request|, asynchronously producing |response|. Consult | 26 // Loads the given |request|, asynchronously producing |response|. Consult |
92 // |response| to determine if the request resulted in an error, was | 27 // |response| to determine if the request resulted in an error, was |
93 // redirected, or has a response body to be consumed. | 28 // redirected, or has a response body to be consumed. |
94 Start(URLRequest request) => (URLResponse response); | 29 Start(URLRequest request) => (URLResponse response); |
95 | 30 |
96 // If the request passed to |Start| had |auto_follow_redirects| set to false, | 31 // If the request passed to |Start| had |auto_follow_redirects| set to false, |
97 // then upon receiving an URLResponse with a non-NULL |redirect_url| field, | 32 // then upon receiving an URLResponse with a non-NULL |redirect_url| field, |
98 // |FollowRedirect| may be called to load the URL indicated by the redirect. | 33 // |FollowRedirect| may be called to load the URL indicated by the redirect. |
99 FollowRedirect() => (URLResponse response); | 34 FollowRedirect() => (URLResponse response); |
100 | 35 |
101 // Query status about the URLLoader. | 36 // Query status about the URLLoader. |
102 QueryStatus() => (URLLoaderStatus status); | 37 QueryStatus() => (URLLoaderStatus status); |
103 }; | 38 }; |
OLD | NEW |