OLD | NEW |
1 /* Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2011 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 | 5 |
6 /* From ppb_url_request_info.idl modified Mon Aug 29 10:11:34 2011. */ | 6 /* From ppb_url_request_info.idl modified Fri Nov 11 19:53:07 2011. */ |
7 | 7 |
8 #ifndef PPAPI_C_PPB_URL_REQUEST_INFO_H_ | 8 #ifndef PPAPI_C_PPB_URL_REQUEST_INFO_H_ |
9 #define PPAPI_C_PPB_URL_REQUEST_INFO_H_ | 9 #define PPAPI_C_PPB_URL_REQUEST_INFO_H_ |
10 | 10 |
11 #include "ppapi/c/pp_bool.h" | 11 #include "ppapi/c/pp_bool.h" |
12 #include "ppapi/c/pp_instance.h" | 12 #include "ppapi/c/pp_instance.h" |
13 #include "ppapi/c/pp_macros.h" | 13 #include "ppapi/c/pp_macros.h" |
14 #include "ppapi/c/pp_resource.h" | 14 #include "ppapi/c/pp_resource.h" |
15 #include "ppapi/c/pp_stdint.h" | 15 #include "ppapi/c/pp_stdint.h" |
16 #include "ppapi/c/pp_time.h" | 16 #include "ppapi/c/pp_time.h" |
(...skipping 11 matching lines...) Expand all Loading... |
28 | 28 |
29 /** | 29 /** |
30 * @addtogroup Enums | 30 * @addtogroup Enums |
31 * @{ | 31 * @{ |
32 */ | 32 */ |
33 /** | 33 /** |
34 * This enumeration contains properties that can be set on a URL request. | 34 * This enumeration contains properties that can be set on a URL request. |
35 */ | 35 */ |
36 typedef enum { | 36 typedef enum { |
37 /** This corresponds to a string (<code>PP_VARTYPE_STRING</code>). */ | 37 /** This corresponds to a string (<code>PP_VARTYPE_STRING</code>). */ |
38 PP_URLREQUESTPROPERTY_URL, | 38 PP_URLREQUESTPROPERTY_URL = 0, |
39 /** | 39 /** |
40 * This corresponds to a string (<code>PP_VARTYPE_STRING</code>); either | 40 * This corresponds to a string (<code>PP_VARTYPE_STRING</code>); either |
41 * POST or GET. Refer to the | 41 * POST or GET. Refer to the |
42 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html">HTTP | 42 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html">HTTP |
43 * Methods</a> documentation for further information. | 43 * Methods</a> documentation for further information. |
44 * | 44 * |
45 */ | 45 */ |
46 PP_URLREQUESTPROPERTY_METHOD, | 46 PP_URLREQUESTPROPERTY_METHOD = 1, |
47 /** | 47 /** |
48 * This corresponds to a string (<code>PP_VARTYPE_STRING</code>); \n | 48 * This corresponds to a string (<code>PP_VARTYPE_STRING</code>); \n |
49 * delimited. Refer to the | 49 * delimited. Refer to the |
50 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"Header | 50 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"Header |
51 * Field Definitions</a> documentaiton for further information. | 51 * Field Definitions</a> documentaiton for further information. |
52 */ | 52 */ |
53 PP_URLREQUESTPROPERTY_HEADERS, | 53 PP_URLREQUESTPROPERTY_HEADERS = 2, |
54 /** | 54 /** |
55 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; | 55 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; |
56 * default=<code>PP_FALSE</code>). | 56 * default=<code>PP_FALSE</code>). |
57 * Set this value to <code>PP_TRUE</code> if you want to download the data | 57 * Set this value to <code>PP_TRUE</code> if you want to download the data |
58 * to a file. Use PPB_URLLoader.FinishStreamingToFile() to complete the | 58 * to a file. Use PPB_URLLoader.FinishStreamingToFile() to complete the |
59 * download. | 59 * download. |
60 */ | 60 */ |
61 PP_URLREQUESTPROPERTY_STREAMTOFILE, | 61 PP_URLREQUESTPROPERTY_STREAMTOFILE = 3, |
62 /** | 62 /** |
63 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; | 63 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; |
64 * default=<code>PP_TRUE</code>). | 64 * default=<code>PP_TRUE</code>). |
65 * Set this value to <code>PP_FALSE</code> if you want to use | 65 * Set this value to <code>PP_FALSE</code> if you want to use |
66 * PPB_URLLoader.FollowRedirects() to follow the redirects only after | 66 * PPB_URLLoader.FollowRedirects() to follow the redirects only after |
67 * examining redirect headers. | 67 * examining redirect headers. |
68 */ | 68 */ |
69 PP_URLREQUESTPROPERTY_FOLLOWREDIRECTS, | 69 PP_URLREQUESTPROPERTY_FOLLOWREDIRECTS = 4, |
70 /** | 70 /** |
71 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; | 71 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; |
72 * default=<code>PP_FALSE</code>). | 72 * default=<code>PP_FALSE</code>). |
73 * Set this value to <code>PP_TRUE</code> if you want to be able to poll the | 73 * Set this value to <code>PP_TRUE</code> if you want to be able to poll the |
74 * download progress using PPB_URLLoader.GetDownloadProgress(). | 74 * download progress using PPB_URLLoader.GetDownloadProgress(). |
75 */ | 75 */ |
76 PP_URLREQUESTPROPERTY_RECORDDOWNLOADPROGRESS, | 76 PP_URLREQUESTPROPERTY_RECORDDOWNLOADPROGRESS = 5, |
77 /** | 77 /** |
78 * This corresponds to a <code>PP_Bool</code> | 78 * This corresponds to a <code>PP_Bool</code> |
79 * (default=<code>PP_FALSE</code>). Set this value to <code>PP_TRUE</code> if | 79 * (default=<code>PP_FALSE</code>). Set this value to <code>PP_TRUE</code> if |
80 * you want to be able to poll the upload progress using | 80 * you want to be able to poll the upload progress using |
81 * PPB_URLLoader.GetUplaodProgress(). | 81 * PPB_URLLoader.GetUplaodProgress(). |
82 */ | 82 */ |
83 PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS, | 83 PP_URLREQUESTPROPERTY_RECORDUPLOADPROGRESS = 6, |
84 /** | 84 /** |
85 * This corresponds to a string (<code>PP_VARTYPE_STRING)</code> or may be | 85 * This corresponds to a string (<code>PP_VARTYPE_STRING)</code> or may be |
86 * undefined (<code>PP_VARTYPE_UNDEFINED</code>; default). | 86 * undefined (<code>PP_VARTYPE_UNDEFINED</code>; default). |
87 * Set it to a string to set a custom referrer (if empty, the referrer header | 87 * Set it to a string to set a custom referrer (if empty, the referrer header |
88 * will be omitted), or to undefined to use the default referrer. Only loaders | 88 * will be omitted), or to undefined to use the default referrer. Only loaders |
89 * with universal access (only available on trusted implementations) will | 89 * with universal access (only available on trusted implementations) will |
90 * accept <code>URLRequestInfo</code> objects that try to set a custom | 90 * accept <code>URLRequestInfo</code> objects that try to set a custom |
91 * referrer; if given to a loader without universal access, | 91 * referrer; if given to a loader without universal access, |
92 * <code>PP_ERROR_NOACCESS</code> will result. | 92 * <code>PP_ERROR_NOACCESS</code> will result. |
93 */ | 93 */ |
94 PP_URLREQUESTPROPERTY_CUSTOMREFERRERURL, | 94 PP_URLREQUESTPROPERTY_CUSTOMREFERRERURL = 7, |
95 /** | 95 /** |
96 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; | 96 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; |
97 * default=<code>PP_FALSE</code>). Whether cross-origin requests are allowed. | 97 * default=<code>PP_FALSE</code>). Whether cross-origin requests are allowed. |
98 * Cross-origin requests are made using the CORS (Cross-Origin Resource | 98 * Cross-origin requests are made using the CORS (Cross-Origin Resource |
99 * Sharing) algorithm to check whether the request should be allowed. For the | 99 * Sharing) algorithm to check whether the request should be allowed. For the |
100 * complete CORS algorithm, refer to | 100 * complete CORS algorithm, refer to |
101 * the <a href="http://www.w3.org/TR/access-control">Cross-Origin Resource | 101 * the <a href="http://www.w3.org/TR/access-control">Cross-Origin Resource |
102 * Sharing</a> documentation. | 102 * Sharing</a> documentation. |
103 */ | 103 */ |
104 PP_URLREQUESTPROPERTY_ALLOWCROSSORIGINREQUESTS, | 104 PP_URLREQUESTPROPERTY_ALLOWCROSSORIGINREQUESTS = 8, |
105 /** | 105 /** |
106 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; | 106 * This corresponds to a <code>PP_Bool</code> (<code>PP_VARTYPE_BOOL</code>; |
107 * default=<code>PP_FALSE</code>). | 107 * default=<code>PP_FALSE</code>). |
108 * Whether HTTP credentials are sent with cross-origin requests. If false, | 108 * Whether HTTP credentials are sent with cross-origin requests. If false, |
109 * no credentials are sent with the request and cookies are ignored in the | 109 * no credentials are sent with the request and cookies are ignored in the |
110 * response. If the request is not cross-origin, this property is ignored. | 110 * response. If the request is not cross-origin, this property is ignored. |
111 */ | 111 */ |
112 PP_URLREQUESTPROPERTY_ALLOWCREDENTIALS, | 112 PP_URLREQUESTPROPERTY_ALLOWCREDENTIALS = 9, |
113 /** | 113 /** |
114 * This corresponds to a string (<code>PP_VARTYPE_STRING</code>) or may be | 114 * This corresponds to a string (<code>PP_VARTYPE_STRING</code>) or may be |
115 * undefined (<code>PP_VARTYPE_UNDEFINED</code>; default). | 115 * undefined (<code>PP_VARTYPE_UNDEFINED</code>; default). |
116 * Set it to a string to set a custom content-transfer-encoding header (if | 116 * Set it to a string to set a custom content-transfer-encoding header (if |
117 * empty, that header will be omitted), or to undefined to use the default | 117 * empty, that header will be omitted), or to undefined to use the default |
118 * (if any). Only loaders with universal access (only available on trusted | 118 * (if any). Only loaders with universal access (only available on trusted |
119 * implementations) will accept <code>URLRequestInfo</code> objects that try | 119 * implementations) will accept <code>URLRequestInfo</code> objects that try |
120 * to set a custom content transfer encoding; if given to a loader without | 120 * to set a custom content transfer encoding; if given to a loader without |
121 * universal access, <code>PP_ERROR_NOACCESS</code> will result. | 121 * universal access, <code>PP_ERROR_NOACCESS</code> will result. |
122 */ | 122 */ |
123 PP_URLREQUESTPROPERTY_CUSTOMCONTENTTRANSFERENCODING, | 123 PP_URLREQUESTPROPERTY_CUSTOMCONTENTTRANSFERENCODING = 10, |
124 /** | 124 /** |
125 * This corresponds to an integer (<code>PP_VARTYPE_INT32</code>); default | 125 * This corresponds to an integer (<code>PP_VARTYPE_INT32</code>); default |
126 * is not defined and is set by the browser, possibly depending on system | 126 * is not defined and is set by the browser, possibly depending on system |
127 * capabilities. Set it to an integer to set an upper threshold for the | 127 * capabilities. Set it to an integer to set an upper threshold for the |
128 * prefetched buffer of an asynchronous load. When exceeded, the browser will | 128 * prefetched buffer of an asynchronous load. When exceeded, the browser will |
129 * defer loading until | 129 * defer loading until |
130 * <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> is hit, | 130 * <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> is hit, |
131 * at which time it will begin prefetching again. When setting this property, | 131 * at which time it will begin prefetching again. When setting this property, |
132 * <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> must also | 132 * <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> must also |
133 * be set. Behavior is undefined if the former is <= the latter. | 133 * be set. Behavior is undefined if the former is <= the latter. |
134 */ | 134 */ |
135 PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD, | 135 PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD = 11, |
136 /** | 136 /** |
137 * This corresponds to an integer (<code>PP_VARTYPE_INT32</code>); default is | 137 * This corresponds to an integer (<code>PP_VARTYPE_INT32</code>); default is |
138 * not defined and is set by the browser to a value appropriate for the | 138 * not defined and is set by the browser to a value appropriate for the |
139 * default <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code>. | 139 * default <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code>. |
140 * Set it to an integer to set a lower threshold for the prefetched buffer | 140 * Set it to an integer to set a lower threshold for the prefetched buffer |
141 * of an asynchronous load. When reached, the browser will resume loading if | 141 * of an asynchronous load. When reached, the browser will resume loading if |
142 * If <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> had | 142 * If <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERERTHRESHOLD</code> had |
143 * previously been reached. | 143 * previously been reached. |
144 * When setting this property, | 144 * When setting this property, |
145 * <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code> must also | 145 * <code>PP_URLREQUESTPROPERTY_PREFETCHBUFFERUPPERTHRESHOLD</code> must also |
146 * be set. Behavior is undefined if the former is >= the latter. | 146 * be set. Behavior is undefined if the former is >= the latter. |
147 */ | 147 */ |
148 PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERTHRESHOLD | 148 PP_URLREQUESTPROPERTY_PREFETCHBUFFERLOWERTHRESHOLD = 12 |
149 } PP_URLRequestProperty; | 149 } PP_URLRequestProperty; |
150 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLRequestProperty, 4); | 150 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLRequestProperty, 4); |
151 /** | 151 /** |
152 * @} | 152 * @} |
153 */ | 153 */ |
154 | 154 |
155 /** | 155 /** |
156 * @addtogroup Interfaces | 156 * @addtogroup Interfaces |
157 * @{ | 157 * @{ |
158 */ | 158 */ |
(...skipping 87 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
246 int64_t start_offset, | 246 int64_t start_offset, |
247 int64_t number_of_bytes, | 247 int64_t number_of_bytes, |
248 PP_Time expected_last_modified_time); | 248 PP_Time expected_last_modified_time); |
249 }; | 249 }; |
250 /** | 250 /** |
251 * @} | 251 * @} |
252 */ | 252 */ |
253 | 253 |
254 #endif /* PPAPI_C_PPB_URL_REQUEST_INFO_H_ */ | 254 #endif /* PPAPI_C_PPB_URL_REQUEST_INFO_H_ */ |
255 | 255 |
OLD | NEW |