1 {{+bindTo:partials.standard_nacl_api}} 2 <h1>PPB_URLRequestInfo Struct Reference</h1> 3 <div id="doxygen-ref"> 4 {{- dummy div to appease doxygen -}} 5 <div> 6 <!-- Generated by Doxygen 1.7.6.1 --> 7 8 9 </div> 10 <!--header--> 11 <div class="contents"> 12 <!-- doxytag: class="PPB_URLRequestInfo" --><h2> 13 Data Fields</h2><table class="memberdecls"> 14 15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#af46135ad86d3444f19a8aa30dd5cd202">Create</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td></tr> 16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#ab23f1a2c86c64b64e806ba85cc5d1817">IsURLRequestInfo</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr> 17 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#a47e9163b0ee627496a249171dc5c53be">SetProperty</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> request, <a class="el" href="group___enums.html#ga41975630f0a4c49e47d4a21754f8402d">PP_URLRequestProperty</a> property, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> value)</td></tr> 18 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#ac27a819ffd3ac75686e436f09c8c0ac1">AppendDataToBody</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> request, const void *data, uint32_t len)</td></tr> 19 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#af6edaa0b0f19cb902e5e1d8b3ad2a43b">AppendFileToBody</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> request, <a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> file_ref, int64_t start_offset, int64_t number_of_bytes, <a class="el" href="group___typedefs.html#ga537b277d2116e42b6acfe9323d40e1a0">PP_Time</a> expected_last_modified_time)</td></tr> 20 </table> 21 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2> 22 <div class="textblock"><p>The <code>PPB_URLRequestInfo</code> interface is used to create and handle URL requests. </p> 23 <p>This API is used in conjunction with <code>PPB_URLLoader</code>. Refer to <code>PPB_URLLoader</code> for further information. </p> 24 </div><hr /><h2>Field Documentation</h2> 25 <a class="anchor" id="ac27a819ffd3ac75686e436f09c8c0ac1"></a><!-- doxytag: member="PPB_URLRequestInfo::AppendDataToBody" ref="ac27a819ffd3ac75686e436f09c8c0ac1" args=")(PP_Resource request, const void *data, uint32_t len)" --> 26 <div class="memitem"> 27 <div class="memproto"> 28 <table class="memname"> 29 <tr> 30 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#ac27a819ffd3ac75686e436f09c8c0ac1">PPB_URLRequestInfo::AppendDataToBody</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> request, const void *data, uint32_t len)</td> 31 </tr> 32 </table> 33 </div> 34 <div class="memdoc"> 35 <p><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#ac27a819ffd3ac75686e436f09c8c0ac1" title="AppendDataToBody() appends data to the request body.">AppendDataToBody()</a> appends data to the request body. </p> 36 <p>A Content-Length request header will be automatically generated.</p> 37 <dl class="params"><dt><b>Parameters:</b></dt><dd> 38 <table class="params"> 39 <tr><td class="paramdir">[in]</td><td class="paramname">request</td><td>A <code>PP_Resource</code> corresponding to a <code>URLRequestInfo</code>. </td></tr> 40 <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to a buffer holding the data. </td></tr> 41 <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>The length, in bytes, of the data.</td></tr> 42 </table> 43 </dd> 44 </dl> 45 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if successful, <code>PP_FALSE</code> if any of the parameters are invalid. </dd></dl> 46 </div> 47 </div> 48 <a class="anchor" id="af6edaa0b0f19cb902e5e1d8b3ad2a43b"></a><!-- doxytag: member="PPB_URLRequestInfo::AppendFileToBody" ref="af6edaa0b0f19cb902e5e1d8b3ad2a43b" args=")(PP_Resource request, PP_Resource file_ref, int64_t start_offset, int64_t number_of_bytes, PP_Time expected_last_modified_time)" --> 49 <div class="memitem"> 50 <div class="memproto"> 51 <table class="memname"> 52 <tr> 53 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#af6edaa0b0f19cb902e5e1d8b3ad2a43b">PPB_URLRequestInfo::AppendFileToBody</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> request, <a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> file_ref, int64_t start_offset, int64_t number_of_bytes, <a class="el" href="group___typedefs.html#ga537b277d2116e42b6acfe9323d40e1a0">PP_Time</a> expected_last_modified_time)</td> 54 </tr> 55 </table> 56 </div> 57 <div class="memdoc"> 58 <p><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#af6edaa0b0f19cb902e5e1d8b3ad2a43b" title="AppendFileToBody() appends a file, to be uploaded, to the request body.">AppendFileToBody()</a> appends a file, to be uploaded, to the request body. </p> 59 <p>A content-length request header will be automatically generated.</p> 60 <dl class="params"><dt><b>Parameters:</b></dt><dd> 61 <table class="params"> 62 <tr><td class="paramdir">[in]</td><td class="paramname">request</td><td>A <code>PP_Resource</code> corresponding to a <code>URLRequestInfo</code>. </td></tr> 63 <tr><td class="paramdir">[in]</td><td class="paramname">file_ref</td><td>A <code>PP_Resource</code> corresponding to a file reference. </td></tr> 64 <tr><td class="paramdir">[in]</td><td class="paramname">start_offset</td><td>An optional starting point offset within the file. </td></tr> 65 <tr><td class="paramdir">[in]</td><td class="paramname">number_of_bytes</td><td>An optional number of bytes of the file to be included. If <code>number_of_bytes</code> is -1, then the sub-range to upload extends to the end of the file. </td></tr> 66 <tr><td class="paramdir">[in]</td><td class="paramname">expected_last_modified_time</td><td>An optional (non-zero) last modified time stamp used to validate that the file was not modified since the given time before it was uploaded. The upload will fail with an error code of <code>PP_ERROR_FILECHANGED</code> if the file has been modified since the given time. If <code>expected_last_modified_time</code> is 0, then no validation is performed.</td></tr> 67 </table> 68 </dd> 69 </dl> 70 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if successful, <code>PP_FALSE</code> if any of the parameters are invalid. </dd></dl> 71 </div> 72 </div> 73 <a class="anchor" id="af46135ad86d3444f19a8aa30dd5cd202"></a><!-- doxytag: member="PPB_URLRequestInfo::Create" ref="af46135ad86d3444f19a8aa30dd5cd202" args=")(PP_Instance instance)" --> 74 <div class="memitem"> 75 <div class="memproto"> 76 <table class="memname"> 77 <tr> 78 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#af46135ad86d3444f19a8aa30dd5cd202">PPB_URLRequestInfo::Create</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance)</td> 79 </tr> 80 </table> 81 </div> 82 <div class="memdoc"> 83 <p><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#af46135ad86d3444f19a8aa30dd5cd202" title="Create() creates a new URLRequestInfo object.">Create()</a> creates a new <code>URLRequestInfo</code> object. </p> 84 <dl class="params"><dt><b>Parameters:</b></dt><dd> 85 <table class="params"> 86 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>A <code>PP_Instance</code> identifying one instance of a module.</td></tr> 87 </table> 88 </dd> 89 </dl> 90 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> identifying the <code>URLRequestInfo</code> if successful, 0 if the instance is invalid. </dd></dl> 91 </div> 92 </div> 93 <a class="anchor" id="ab23f1a2c86c64b64e806ba85cc5d1817"></a><!-- doxytag: member="PPB_URLRequestInfo::IsURLRequestInfo" ref="ab23f1a2c86c64b64e806ba85cc5d1817" args=")(PP_Resource resource)" --> 94 <div class="memitem"> 95 <div class="memproto"> 96 <table class="memname"> 97 <tr> 98 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#ab23f1a2c86c64b64e806ba85cc5d1817">PPB_URLRequestInfo::IsURLRequestInfo</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td> 99 </tr> 100 </table> 101 </div> 102 <div class="memdoc"> 103 <p><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#ab23f1a2c86c64b64e806ba85cc5d1817" title="IsURLRequestInfo() determines if a resource is a URLRequestInfo.">IsURLRequestInfo()</a> determines if a resource is a <code>URLRequestInfo</code>. </p> 104 <dl class="params"><dt><b>Parameters:</b></dt><dd> 105 <table class="params"> 106 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a <code>URLRequestInfo</code>.</td></tr> 107 </table> 108 </dd> 109 </dl> 110 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the resource is a <code>URLRequestInfo</code>, <code>PP_FALSE</code> if the resource is invalid or some type other than <code>URLRequestInfo</code>. </dd></dl> 111 </div> 112 </div> 113 <a class="anchor" id="a47e9163b0ee627496a249171dc5c53be"></a><!-- doxytag: member="PPB_URLRequestInfo::SetProperty" ref="a47e9163b0ee627496a249171dc5c53be" args=")(PP_Resource request, PP_URLRequestProperty property, struct PP_Var value)" --> 114 <div class="memitem"> 115 <div class="memproto"> 116 <table class="memname"> 117 <tr> 118 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#a47e9163b0ee627496a249171dc5c53be">PPB_URLRequestInfo::SetProperty</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> request, <a class="el" href="group___enums.html#ga41975630f0a4c49e47d4a21754f8402d">PP_URLRequestProperty</a> property, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> value)</td> 119 </tr> 120 </table> 121 </div> 122 <div class="memdoc"> 123 <p><a class="el" href="struct_p_p_b___u_r_l_request_info__1__0.html#a47e9163b0ee627496a249171dc5c53be" title="SetProperty() sets a request property.">SetProperty()</a> sets a request property. </p> 124 <p>The value of the property must be the correct type according to the property being set.</p> 125 <dl class="params"><dt><b>Parameters:</b></dt><dd> 126 <table class="params"> 127 <tr><td class="paramdir">[in]</td><td class="paramname">request</td><td>A <code>PP_Resource</code> corresponding to a <code>URLRequestInfo</code>. </td></tr> 128 <tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>A <code>PP_URLRequestProperty</code> identifying the property to set. </td></tr> 129 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>A <code><a class="el" href="struct_p_p___var.html" title="The PP_VAR struct is a variant data type and can contain any value of one of the types named in the P...">PP_Var</a></code> containing the property value.</td></tr> 130 </table> 131 </dd> 132 </dl> 133 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if successful, <code>PP_FALSE</code> if any of the parameters are invalid. </dd></dl> 134 </div> 135 </div> 136 <hr />The documentation for this struct was generated from the following file:<ul> 137 <li><a class="el" href="ppb__url__request__info_8h.html">ppb_url_request_info.h</a></li> 138 </ul> 139 </div><!-- contents --> 140 </div> 141 {{/partials.standard_nacl_api}} 142
