src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_u_r_l_response_info.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::URLResponseInfo Class 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
  10 </div>
  11 <!--header-->
  12 <div class="contents">
  13 <!-- doxytag: class="pp::URLResponseInfo" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  14 Inheritance diagram for pp::URLResponseInfo:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_u_r_l_response_info__inherit__graph.png" border="0" usemap="#pp_1_1_u_r_l_response_info_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_u_r_l_response_info_inherit__map" id="pp_1_1_u_r_l_response_info_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="31,5,135,35"></area></map>
  19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  20 <p><a href="classpp_1_1_u_r_l_response_info-members.html">List of all members.</a></p>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">URLResponseInfo</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a157bf323368bc4b7e63ce604ecc272c1">URLResponseInfo</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#aa2fb382084c248e56dffb09e1191a6f1">URLResponseInfo</a> (const <a class="el" href="classpp_1_1_u_r_l_response_info.html">URLResponseInfo</a> &amp;other)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#ac30d83aa38148e6d90f3c22ab01b10dc">GetProperty</a> (PP_URLResponseProperty property) const </td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_file_ref.html">FileRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a77debd316d7b575b6cae43cb1bb14cbc">GetBodyAsFileRef</a> () const </td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#ad53acecc41062e0b60167b78c268a0bb">GetURL</a> () const </td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a6c25ffe56f7d9da0817fd84346bbaf10">GetRedirectURL</a> () const </td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a3ae355f52b46a6d2e65fed19bfcec323">GetRedirectMethod</a> () const </td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#aa7d27c0d6af582dc374461c8d0f868b3">GetStatusCode</a> () const </td></tr>
  33 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#aa6b506dff751344d0b85f596ab1a41a8">GetStatusLine</a> () const </td></tr>
  34 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_u_r_l_response_info.html#ae1fbc3ec4025534fbbf7e152af8308c7">GetHeaders</a> () const </td></tr>
  35 </table>
  36 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  37 <div class="textblock"><p><a class="el" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses.">URLResponseInfo</a> provides an API for examining URL responses. </p>
  38 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  39 <a class="anchor" id="a239b1eb1076f2da6c75af416c8f02e6b"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="a239b1eb1076f2da6c75af416c8f02e6b" args="()" -->
  40 <div class="memitem">
  41 <div class="memproto">
  42 <table class="memname">
  43 <tr>
  44 <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td>
  45 <td>(</td>
  46 <td class="paramname"></td><td>)</td>
  47 <td><code> [inline]</code></td>
  48 </tr>
  49 </table>
  50 </div>
  51 <div class="memdoc">
  52 <p>Default constructor. </p>
  53 <p>This constructor creates an <code>is_null</code> resource. </p>
  54 </div>
  55 </div>
  56 <a class="anchor" id="a157bf323368bc4b7e63ce604ecc272c1"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="a157bf323368bc4b7e63ce604ecc272c1" args="(PassRef, PP_Resource resource)" -->
  57 <div class="memitem">
  58 <div class="memproto">
  59 <table class="memname">
  60 <tr>
  61 <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td>
  62 <td>(</td>
  63 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
  64 <td class="paramname">, </td>
  65 </tr>
  66 <tr>
  67 <td class="paramkey"></td>
  68 <td></td>
  69 <td class="paramtype">PP_Resource&#160;</td>
  70 <td class="paramname"><em>resource</em>&#160;</td>
  71 </tr>
  72 <tr>
  73 <td></td>
  74 <td>)</td>
  75 <td></td><td></td>
  76 </tr>
  77 </table>
  78 </div>
  79 <div class="memdoc">
  80 <p>A constructor used when you have received a <code>PP_Resource</code> as a return value that has already been reference counted. </p>
  81 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  82 <table class="params">
  83 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a resource. </td></tr>
  84 </table>
  85 </dd>
  86 </dl>
  87 </div>
  88 </div>
  89 <a class="anchor" id="aa2fb382084c248e56dffb09e1191a6f1"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="aa2fb382084c248e56dffb09e1191a6f1" args="(const URLResponseInfo &amp;other)" -->
  90 <div class="memitem">
  91 <div class="memproto">
  92 <table class="memname">
  93 <tr>
  94 <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td>
  95 <td>(</td>
  96 <td class="paramtype">const <a class="el" href="classpp_1_1_u_r_l_response_info.html">URLResponseInfo</a> &amp;&#160;</td>
  97 <td class="paramname"><em>other</em></td><td>)</td>
  98 <td></td>
  99 </tr>
 100 </table>
 101 </div>
 102 <div class="memdoc">
 103 <p>The copy constructor for <code><a class="el" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses.">URLResponseInfo</a></code>. </p>
 104 </div>
 105 </div>
 106 <hr /><h2>Member Function Documentation</h2>
 107 <a class="anchor" id="a77debd316d7b575b6cae43cb1bb14cbc"></a><!-- doxytag: member="pp::URLResponseInfo::GetBodyAsFileRef" ref="a77debd316d7b575b6cae43cb1bb14cbc" args="() const " -->
 108 <div class="memitem">
 109 <div class="memproto">
 110 <table class="memname">
 111 <tr>
 112 <td class="memname"><a class="el" href="classpp_1_1_file_ref.html">FileRef</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#a77debd316d7b575b6cae43cb1bb14cbc">pp::URLResponseInfo::GetBodyAsFileRef</a> </td>
 113 <td>(</td>
 114 <td class="paramname"></td><td>)</td>
 115 <td> const</td>
 116 </tr>
 117 </table>
 118 </div>
 119 <div class="memdoc">
 120 <p>This function returns a <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> pointing to the file containing the response body. </p>
 121 <p>This is only valid if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was set on the <code><a class="el" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests.">URLRequestInfo</a></code> used to produce this response. This file remains valid until the <code><a class="el" href="classpp_1_1_u_r_l_loader.html" title="URLLoader provides an API for loading URLs.">URLLoader</a></code> associated with this <code><a class="el" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses.">URLResponseInfo</a></code> is closed or destroyed.</p>
 122 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> corresponding to a <code><a class="el" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.'>FileRef</a></code> if successful, an <code>is_null</code> object if <code>PP_URLREQUESTPROPERTY_STREAMTOFILE</code> was not requested or if the <code><a class="el" href="classpp_1_1_u_r_l_loader.html" title="URLLoader provides an API for loading URLs.">URLLoader</a></code> has not been opened yet. </dd></dl>
 123 </div>
 124 </div>
 125 <a class="anchor" id="ae1fbc3ec4025534fbbf7e152af8308c7"></a><!-- doxytag: member="pp::URLResponseInfo::GetHeaders" ref="ae1fbc3ec4025534fbbf7e152af8308c7" args="() const " -->
 126 <div class="memitem">
 127 <div class="memproto">
 128 <table class="memname">
 129 <tr>
 130 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#ae1fbc3ec4025534fbbf7e152af8308c7">pp::URLResponseInfo::GetHeaders</a> </td>
 131 <td>(</td>
 132 <td class="paramname"></td><td>)</td>
 133 <td> const<code> [inline]</code></td>
 134 </tr>
 135 </table>
 136 </div>
 137 <div class="memdoc">
 138 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_HEADERS</code> property for the response. </p>
 139 <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 140 </div>
 141 </div>
 142 <a class="anchor" id="ac30d83aa38148e6d90f3c22ab01b10dc"></a><!-- doxytag: member="pp::URLResponseInfo::GetProperty" ref="ac30d83aa38148e6d90f3c22ab01b10dc" args="(PP_URLResponseProperty property) const " -->
 143 <div class="memitem">
 144 <div class="memproto">
 145 <table class="memname">
 146 <tr>
 147 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#ac30d83aa38148e6d90f3c22ab01b10dc">pp::URLResponseInfo::GetProperty</a> </td>
 148 <td>(</td>
 149 <td class="paramtype">PP_URLResponseProperty&#160;</td>
 150 <td class="paramname"><em>property</em></td><td>)</td>
 151 <td> const</td>
 152 </tr>
 153 </table>
 154 </div>
 155 <div class="memdoc">
 156 <p>This function gets a response property. </p>
 157 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 158 <table class="params">
 159 <tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>A <code>PP_URLResponseProperty</code> identifying the type of property in the response.</td></tr>
 160 </table>
 161 </dd>
 162 </dl>
 163 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 164 </div>
 165 </div>
 166 <a class="anchor" id="a3ae355f52b46a6d2e65fed19bfcec323"></a><!-- doxytag: member="pp::URLResponseInfo::GetRedirectMethod" ref="a3ae355f52b46a6d2e65fed19bfcec323" args="() const " -->
 167 <div class="memitem">
 168 <div class="memproto">
 169 <table class="memname">
 170 <tr>
 171 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#a3ae355f52b46a6d2e65fed19bfcec323">pp::URLResponseInfo::GetRedirectMethod</a> </td>
 172 <td>(</td>
 173 <td class="paramname"></td><td>)</td>
 174 <td> const<code> [inline]</code></td>
 175 </tr>
 176 </table>
 177 </div>
 178 <div class="memdoc">
 179 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_REDIRECTMETHOD</code> property for the response. </p>
 180 <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 181 </div>
 182 </div>
 183 <a class="anchor" id="a6c25ffe56f7d9da0817fd84346bbaf10"></a><!-- doxytag: member="pp::URLResponseInfo::GetRedirectURL" ref="a6c25ffe56f7d9da0817fd84346bbaf10" args="() const " -->
 184 <div class="memitem">
 185 <div class="memproto">
 186 <table class="memname">
 187 <tr>
 188 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#a6c25ffe56f7d9da0817fd84346bbaf10">pp::URLResponseInfo::GetRedirectURL</a> </td>
 189 <td>(</td>
 190 <td class="paramname"></td><td>)</td>
 191 <td> const<code> [inline]</code></td>
 192 </tr>
 193 </table>
 194 </div>
 195 <div class="memdoc">
 196 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_REDIRECTURL</code> property for the response. </p>
 197 <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 198 </div>
 199 </div>
 200 <a class="anchor" id="aa7d27c0d6af582dc374461c8d0f868b3"></a><!-- doxytag: member="pp::URLResponseInfo::GetStatusCode" ref="aa7d27c0d6af582dc374461c8d0f868b3" args="() const " -->
 201 <div class="memitem">
 202 <div class="memproto">
 203 <table class="memname">
 204 <tr>
 205 <td class="memname">int32_t <a class="el" href="classpp_1_1_u_r_l_response_info.html#aa7d27c0d6af582dc374461c8d0f868b3">pp::URLResponseInfo::GetStatusCode</a> </td>
 206 <td>(</td>
 207 <td class="paramname"></td><td>)</td>
 208 <td> const<code> [inline]</code></td>
 209 </tr>
 210 </table>
 211 </div>
 212 <div class="memdoc">
 213 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_STATUSCODE</code> property for the response. </p>
 214 <dl class="return"><dt><b>Returns:</b></dt><dd>A int32_t containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 215 </div>
 216 </div>
 217 <a class="anchor" id="aa6b506dff751344d0b85f596ab1a41a8"></a><!-- doxytag: member="pp::URLResponseInfo::GetStatusLine" ref="aa6b506dff751344d0b85f596ab1a41a8" args="() const " -->
 218 <div class="memitem">
 219 <div class="memproto">
 220 <table class="memname">
 221 <tr>
 222 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#aa6b506dff751344d0b85f596ab1a41a8">pp::URLResponseInfo::GetStatusLine</a> </td>
 223 <td>(</td>
 224 <td class="paramname"></td><td>)</td>
 225 <td> const<code> [inline]</code></td>
 226 </tr>
 227 </table>
 228 </div>
 229 <div class="memdoc">
 230 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_STATUSLINE</code> property for the response. </p>
 231 <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 232 </div>
 233 </div>
 234 <a class="anchor" id="ad53acecc41062e0b60167b78c268a0bb"></a><!-- doxytag: member="pp::URLResponseInfo::GetURL" ref="ad53acecc41062e0b60167b78c268a0bb" args="() const " -->
 235 <div class="memitem">
 236 <div class="memproto">
 237 <table class="memname">
 238 <tr>
 239 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_u_r_l_response_info.html#ad53acecc41062e0b60167b78c268a0bb">pp::URLResponseInfo::GetURL</a> </td>
 240 <td>(</td>
 241 <td class="paramname"></td><td>)</td>
 242 <td> const<code> [inline]</code></td>
 243 </tr>
 244 </table>
 245 </div>
 246 <div class="memdoc">
 247 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_URL</code> property for the response. </p>
 248 <dl class="return"><dt><b>Returns:</b></dt><dd>An <code>is_string <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> containing the response property value if successful, <code>is_undefined <a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> if an input parameter is invalid. </dd></dl>
 249 </div>
 250 </div>
 251 <hr />The documentation for this class was generated from the following file:<ul>
 252 <li><a class="el" href="url__response__info_8h.html">url_response_info.h</a></li>
 253 </ul>
 254 </div><!-- contents -->
 255 </div>
 256 {{/partials.standard_nacl_article}}