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 /** | 6 /** |
7 * This file defines the <code>PPB_URLRequestInfo</code> API for creating and | 7 * This file defines the <code>PPB_URLRequestInfo</code> API for creating and |
8 * manipulating URL requests. | 8 * manipulating URL requests. |
9 */ | 9 */ |
10 | 10 |
(...skipping 136 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
147 /** | 147 /** |
148 * The <code>PPB_URLRequestInfo</code> interface is used to create | 148 * The <code>PPB_URLRequestInfo</code> interface is used to create |
149 * and handle URL requests. This API is used in conjunction with | 149 * and handle URL requests. This API is used in conjunction with |
150 * <code>PPB_URLLoader</code>. Refer to <code>PPB_URLLoader</code> for further | 150 * <code>PPB_URLLoader</code>. Refer to <code>PPB_URLLoader</code> for further |
151 * information. | 151 * information. |
152 */ | 152 */ |
153 interface PPB_URLRequestInfo { | 153 interface PPB_URLRequestInfo { |
154 /** | 154 /** |
155 * Create() creates a new <code>URLRequestInfo</code> object. | 155 * Create() creates a new <code>URLRequestInfo</code> object. |
156 * | 156 * |
157 * @param[in] instance A <code>PP_Instance</code> indentifying one instance | 157 * @param[in] instance A <code>PP_Instance</code> identifying one instance |
158 * of a module. | 158 * of a module. |
159 * | 159 * |
160 * @return A <code>PP_Resource</code> identifying the | 160 * @return A <code>PP_Resource</code> identifying the |
161 * <code>URLRequestInfo</code> if successful, 0 if the instance is invalid. | 161 * <code>URLRequestInfo</code> if successful, 0 if the instance is invalid. |
162 */ | 162 */ |
163 PP_Resource Create( | 163 PP_Resource Create( |
164 [in] PP_Instance instance); | 164 [in] PP_Instance instance); |
165 | 165 |
166 /** | 166 /** |
167 * IsURLRequestInfo() determines if a resource is a | 167 * IsURLRequestInfo() determines if a resource is a |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
213 [in] PP_Resource request, | 213 [in] PP_Resource request, |
214 [in] mem_t data, | 214 [in] mem_t data, |
215 [in] uint32_t len); | 215 [in] uint32_t len); |
216 | 216 |
217 /** | 217 /** |
218 * AppendFileToBody() appends a file, to be uploaded, to the request body. | 218 * AppendFileToBody() appends a file, to be uploaded, to the request body. |
219 * A content-length request header will be automatically generated. | 219 * A content-length request header will be automatically generated. |
220 * | 220 * |
221 * @param[in] request A <code>PP_Resource</code> corresponding to a | 221 * @param[in] request A <code>PP_Resource</code> corresponding to a |
222 * <code>URLRequestInfo</code>. | 222 * <code>URLRequestInfo</code>. |
223 * @param[in] file_ref A <code>PP_Resource</code> containing the file | 223 * @param[in] file_ref A <code>PP_Resource</code> corresponding to a file |
224 * reference. | 224 * reference. |
225 * @param[in] start_offset An optional starting point offset within the | 225 * @param[in] start_offset An optional starting point offset within the |
226 * file. | 226 * file. |
227 * @param[in] number_of_bytes An optional number of bytes of the file to | 227 * @param[in] number_of_bytes An optional number of bytes of the file to |
228 * be included. If <code>number_of_bytes</code> is -1, then the sub-range | 228 * be included. If <code>number_of_bytes</code> is -1, then the sub-range |
229 * to upload extends to the end of the file. | 229 * to upload extends to the end of the file. |
230 * @param[in] expected_last_modified_time An optional (non-zero) last | 230 * @param[in] expected_last_modified_time An optional (non-zero) last |
231 * modified time stamp used to validate that the file was not modified since | 231 * modified time stamp used to validate that the file was not modified since |
232 * the given time before it was uploaded. The upload will fail with an error | 232 * the given time before it was uploaded. The upload will fail with an error |
233 * code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified | 233 * code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified |
234 * since the given time. If <code>expected_last_modified_time</code> is 0, | 234 * since the given time. If <code>expected_last_modified_time</code> is 0, |
235 * then no validation is performed. | 235 * then no validation is performed. |
236 * | 236 * |
237 * @return <code>PP_TRUE</code> if successful, <code>PP_FALSE</code> if any | 237 * @return <code>PP_TRUE</code> if successful, <code>PP_FALSE</code> if any |
238 * of the parameters are invalid. | 238 * of the parameters are invalid. |
239 */ | 239 */ |
240 PP_Bool AppendFileToBody( | 240 PP_Bool AppendFileToBody( |
241 [in] PP_Resource request, | 241 [in] PP_Resource request, |
242 [in] PP_Resource file_ref, | 242 [in] PP_Resource file_ref, |
243 [in] int64_t start_offset, | 243 [in] int64_t start_offset, |
244 [in] int64_t number_of_bytes, | 244 [in] int64_t number_of_bytes, |
245 [in] PP_Time expected_last_modified_time); | 245 [in] PP_Time expected_last_modified_time); |
246 }; | 246 }; |
247 | 247 |
OLD | NEW |