OLD | NEW |
1 /* Copyright (c) 2010 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2010 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 #ifndef PPAPI_C_PPB_URL_RESPONSE_INFO_H_ | 5 #ifndef PPAPI_C_PPB_URL_RESPONSE_INFO_H_ |
6 #define PPAPI_C_PPB_URL_RESPONSE_INFO_H_ | 6 #define PPAPI_C_PPB_URL_RESPONSE_INFO_H_ |
7 | 7 |
8 #include "ppapi/c/pp_bool.h" | 8 #include "ppapi/c/pp_bool.h" |
9 #include "ppapi/c/pp_macros.h" | 9 #include "ppapi/c/pp_macros.h" |
10 #include "ppapi/c/pp_resource.h" | 10 #include "ppapi/c/pp_resource.h" |
11 #include "ppapi/c/pp_var.h" | 11 #include "ppapi/c/pp_var.h" |
12 | 12 |
| 13 /** |
| 14 * |
| 15 * @addtogroup Enums |
| 16 * @{ |
| 17 */ |
13 typedef enum { | 18 typedef enum { |
14 PP_URLRESPONSEPROPERTY_URL, // string | 19 PP_URLRESPONSEPROPERTY_URL, // string |
15 PP_URLRESPONSEPROPERTY_REDIRECTURL, // string | 20 PP_URLRESPONSEPROPERTY_REDIRECTURL, // string |
16 PP_URLRESPONSEPROPERTY_REDIRECTMETHOD, // string | 21 PP_URLRESPONSEPROPERTY_REDIRECTMETHOD, // string |
17 PP_URLRESPONSEPROPERTY_STATUSCODE, // int32 | 22 PP_URLRESPONSEPROPERTY_STATUSCODE, // int32 |
18 PP_URLRESPONSEPROPERTY_STATUSLINE, // string | 23 PP_URLRESPONSEPROPERTY_STATUSLINE, // string |
19 PP_URLRESPONSEPROPERTY_HEADERS // string, \n-delim | 24 PP_URLRESPONSEPROPERTY_HEADERS // string, \n-delim |
20 } PP_URLResponseProperty; | 25 } PP_URLResponseProperty; |
| 26 /** |
| 27 * @} |
| 28 */ |
| 29 |
21 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLResponseProperty, 4); | 30 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_URLResponseProperty, 4); |
22 | 31 |
23 #define PPB_URLRESPONSEINFO_INTERFACE "PPB_URLResponseInfo;0.1" | 32 #define PPB_URLRESPONSEINFO_INTERFACE "PPB_URLResponseInfo;0.1" |
24 | 33 |
| 34 /** |
| 35 * @file |
| 36 * Defines the API ... |
| 37 */ |
| 38 |
| 39 /** |
| 40 * |
| 41 * @addtogroup Interfaces |
| 42 * @{ |
| 43 */ |
25 struct PPB_URLResponseInfo { | 44 struct PPB_URLResponseInfo { |
26 // Returns PP_TRUE if the given resource is an URLResponseInfo. Returns | 45 // Returns PP_TRUE if the given resource is an URLResponseInfo. Returns |
27 // PP_FALSE if the resource is invalid or some type other than an | 46 // PP_FALSE if the resource is invalid or some type other than an |
28 // URLResponseInfo. | 47 // URLResponseInfo. |
29 PP_Bool (*IsURLResponseInfo)(PP_Resource resource); | 48 PP_Bool (*IsURLResponseInfo)(PP_Resource resource); |
30 | 49 |
31 // Gets a response property. Return PP_VarType_Void if an input parameter is | 50 // Gets a response property. Return PP_VarType_Void if an input parameter is |
32 // invalid. | 51 // invalid. |
33 struct PP_Var (*GetProperty)(PP_Resource response, | 52 struct PP_Var (*GetProperty)(PP_Resource response, |
34 PP_URLResponseProperty property); | 53 PP_URLResponseProperty property); |
35 | 54 |
36 // Returns a FileRef pointing to the file containing the response body. This | 55 // Returns a FileRef pointing to the file containing the response body. This |
37 // is only valid if PP_URLREQUESTPROPERTY_STREAMTOFILE was set on the | 56 // is only valid if PP_URLREQUESTPROPERTY_STREAMTOFILE was set on the |
38 // URLRequestInfo used to produce this response. This file remains valid | 57 // URLRequestInfo used to produce this response. This file remains valid |
39 // until the URLLoader associated with this URLResponseInfo is closed or | 58 // until the URLLoader associated with this URLResponseInfo is closed or |
40 // destroyed. Returns 0 if PP_URLREQUESTPROPERTY_STREAMTOFILE was not | 59 // destroyed. Returns 0 if PP_URLREQUESTPROPERTY_STREAMTOFILE was not |
41 // requested or if the URLLoader has not been opened yet. | 60 // requested or if the URLLoader has not been opened yet. |
42 PP_Resource (*GetBodyAsFileRef)(PP_Resource response); | 61 PP_Resource (*GetBodyAsFileRef)(PP_Resource response); |
43 }; | 62 }; |
| 63 /** |
| 64 * @} |
| 65 */ |
44 | 66 |
45 #endif /* PPAPI_C_PPB_URL_RESPONSE_INFO_H_ */ | 67 #endif /* PPAPI_C_PPB_URL_RESPONSE_INFO_H_ */ |
46 | 68 |
OLD | NEW |