3fdc3f63c4b02e833320f94e6d3fa3dd6475d039
[platform/framework/web/crosswalk.git] / src / native_client_sdk / doc_generated / pepper_stable / 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>
4 <!-- Generated by Doxygen 1.7.6.1 -->
5
6
7
8 </div>
9 <!--header-->
10 <div class="contents">
11 <!-- doxytag: class="pp::URLResponseInfo" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
12 Inheritance diagram for pp::URLResponseInfo:</div>
13 <div class="dyncontent">
14 <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>
15 <map name="pp_1_1_u_r_l_response_info_inherit__map" id="pp_1_1_u_r_l_response_info_inherit__map">
16 <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>
17 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
18 <p><a href="classpp_1_1_u_r_l_response_info-members.html">List of all members.</a></p>
19 <h2>
20 Public Member Functions</h2><table class="memberdecls">
21
22 <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>
23 <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>
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#aa2fb382084c248e56dffb09e1191a6f1">URLResponseInfo</a> (const <a class="el" href="classpp_1_1_u_r_l_response_info.html">URLResponseInfo</a> &amp;other)</td></tr>
25 <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>
26 <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>
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#ad53acecc41062e0b60167b78c268a0bb">GetURL</a> () const </td></tr>
28 <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>
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#a3ae355f52b46a6d2e65fed19bfcec323">GetRedirectMethod</a> () const </td></tr>
30 <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>
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#aa6b506dff751344d0b85f596ab1a41a8">GetStatusLine</a> () const </td></tr>
32 <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>
33 </table>
34 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
35 <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>
36 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
37 <a class="anchor" id="a239b1eb1076f2da6c75af416c8f02e6b"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="a239b1eb1076f2da6c75af416c8f02e6b" args="()" -->
38 <div class="memitem">
39 <div class="memproto">
40 <table class="memname">
41 <tr>
42 <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td>
43 <td>(</td>
44 <td class="paramname"></td><td>)</td>
45 <td><code> [inline]</code></td>
46 </tr>
47 </table>
48 </div>
49 <div class="memdoc">
50 <p>Default constructor. </p>
51 <p>This constructor creates an <code>is_null</code> resource. </p>
52 </div>
53 </div>
54 <a class="anchor" id="a157bf323368bc4b7e63ce604ecc272c1"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="a157bf323368bc4b7e63ce604ecc272c1" args="(PassRef, PP_Resource resource)" -->
55 <div class="memitem">
56 <div class="memproto">
57 <table class="memname">
58 <tr>
59 <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td>
60 <td>(</td>
61 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
62 <td class="paramname">, </td>
63 </tr>
64 <tr>
65 <td class="paramkey"></td>
66 <td></td>
67 <td class="paramtype">PP_Resource&#160;</td>
68 <td class="paramname"><em>resource</em>&#160;</td>
69 </tr>
70 <tr>
71 <td></td>
72 <td>)</td>
73 <td></td><td></td>
74 </tr>
75 </table>
76 </div>
77 <div class="memdoc">
78 <p>A constructor used when you have received a <code>PP_Resource</code> as a return value that has already been reference counted. </p>
79 <dl class="params"><dt><b>Parameters:</b></dt><dd>
80 <table class="params">
81 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a resource. </td></tr>
82 </table>
83 </dd>
84 </dl>
85 </div>
86 </div>
87 <a class="anchor" id="aa2fb382084c248e56dffb09e1191a6f1"></a><!-- doxytag: member="pp::URLResponseInfo::URLResponseInfo" ref="aa2fb382084c248e56dffb09e1191a6f1" args="(const URLResponseInfo &amp;other)" -->
88 <div class="memitem">
89 <div class="memproto">
90 <table class="memname">
91 <tr>
92 <td class="memname"><a class="el" href="classpp_1_1_u_r_l_response_info.html#a239b1eb1076f2da6c75af416c8f02e6b">pp::URLResponseInfo::URLResponseInfo</a> </td>
93 <td>(</td>
94 <td class="paramtype">const <a class="el" href="classpp_1_1_u_r_l_response_info.html">URLResponseInfo</a> &amp;&#160;</td>
95 <td class="paramname"><em>other</em></td><td>)</td>
96 <td></td>
97 </tr>
98 </table>
99 </div>
100 <div class="memdoc">
101 <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>
102 </div>
103 </div>
104 <hr /><h2>Member Function Documentation</h2>
105 <a class="anchor" id="a77debd316d7b575b6cae43cb1bb14cbc"></a><!-- doxytag: member="pp::URLResponseInfo::GetBodyAsFileRef" ref="a77debd316d7b575b6cae43cb1bb14cbc" args="() const " -->
106 <div class="memitem">
107 <div class="memproto">
108 <table class="memname">
109 <tr>
110 <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>
111 <td>(</td>
112 <td class="paramname"></td><td>)</td>
113 <td> const</td>
114 </tr>
115 </table>
116 </div>
117 <div class="memdoc">
118 <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>
119 <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>
120 <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>
121 </div>
122 </div>
123 <a class="anchor" id="ae1fbc3ec4025534fbbf7e152af8308c7"></a><!-- doxytag: member="pp::URLResponseInfo::GetHeaders" ref="ae1fbc3ec4025534fbbf7e152af8308c7" args="() const " -->
124 <div class="memitem">
125 <div class="memproto">
126 <table class="memname">
127 <tr>
128 <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>
129 <td>(</td>
130 <td class="paramname"></td><td>)</td>
131 <td> const<code> [inline]</code></td>
132 </tr>
133 </table>
134 </div>
135 <div class="memdoc">
136 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_HEADERS</code> property for the response. </p>
137 <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>
138 </div>
139 </div>
140 <a class="anchor" id="ac30d83aa38148e6d90f3c22ab01b10dc"></a><!-- doxytag: member="pp::URLResponseInfo::GetProperty" ref="ac30d83aa38148e6d90f3c22ab01b10dc" args="(PP_URLResponseProperty property) const " -->
141 <div class="memitem">
142 <div class="memproto">
143 <table class="memname">
144 <tr>
145 <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>
146 <td>(</td>
147 <td class="paramtype">PP_URLResponseProperty&#160;</td>
148 <td class="paramname"><em>property</em></td><td>)</td>
149 <td> const</td>
150 </tr>
151 </table>
152 </div>
153 <div class="memdoc">
154 <p>This function gets a response property. </p>
155 <dl class="params"><dt><b>Parameters:</b></dt><dd>
156 <table class="params">
157 <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>
158 </table>
159 </dd>
160 </dl>
161 <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>
162 </div>
163 </div>
164 <a class="anchor" id="a3ae355f52b46a6d2e65fed19bfcec323"></a><!-- doxytag: member="pp::URLResponseInfo::GetRedirectMethod" ref="a3ae355f52b46a6d2e65fed19bfcec323" args="() const " -->
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
168 <tr>
169 <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>
170 <td>(</td>
171 <td class="paramname"></td><td>)</td>
172 <td> const<code> [inline]</code></td>
173 </tr>
174 </table>
175 </div>
176 <div class="memdoc">
177 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_REDIRECTMETHOD</code> property for the response. </p>
178 <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>
179 </div>
180 </div>
181 <a class="anchor" id="a6c25ffe56f7d9da0817fd84346bbaf10"></a><!-- doxytag: member="pp::URLResponseInfo::GetRedirectURL" ref="a6c25ffe56f7d9da0817fd84346bbaf10" args="() const " -->
182 <div class="memitem">
183 <div class="memproto">
184 <table class="memname">
185 <tr>
186 <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>
187 <td>(</td>
188 <td class="paramname"></td><td>)</td>
189 <td> const<code> [inline]</code></td>
190 </tr>
191 </table>
192 </div>
193 <div class="memdoc">
194 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_REDIRECTURL</code> property for the response. </p>
195 <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>
196 </div>
197 </div>
198 <a class="anchor" id="aa7d27c0d6af582dc374461c8d0f868b3"></a><!-- doxytag: member="pp::URLResponseInfo::GetStatusCode" ref="aa7d27c0d6af582dc374461c8d0f868b3" args="() const " -->
199 <div class="memitem">
200 <div class="memproto">
201 <table class="memname">
202 <tr>
203 <td class="memname">int32_t <a class="el" href="classpp_1_1_u_r_l_response_info.html#aa7d27c0d6af582dc374461c8d0f868b3">pp::URLResponseInfo::GetStatusCode</a> </td>
204 <td>(</td>
205 <td class="paramname"></td><td>)</td>
206 <td> const<code> [inline]</code></td>
207 </tr>
208 </table>
209 </div>
210 <div class="memdoc">
211 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_STATUSCODE</code> property for the response. </p>
212 <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>
213 </div>
214 </div>
215 <a class="anchor" id="aa6b506dff751344d0b85f596ab1a41a8"></a><!-- doxytag: member="pp::URLResponseInfo::GetStatusLine" ref="aa6b506dff751344d0b85f596ab1a41a8" args="() const " -->
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
219 <tr>
220 <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>
221 <td>(</td>
222 <td class="paramname"></td><td>)</td>
223 <td> const<code> [inline]</code></td>
224 </tr>
225 </table>
226 </div>
227 <div class="memdoc">
228 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_STATUSLINE</code> property for the response. </p>
229 <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>
230 </div>
231 </div>
232 <a class="anchor" id="ad53acecc41062e0b60167b78c268a0bb"></a><!-- doxytag: member="pp::URLResponseInfo::GetURL" ref="ad53acecc41062e0b60167b78c268a0bb" args="() const " -->
233 <div class="memitem">
234 <div class="memproto">
235 <table class="memname">
236 <tr>
237 <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>
238 <td>(</td>
239 <td class="paramname"></td><td>)</td>
240 <td> const<code> [inline]</code></td>
241 </tr>
242 </table>
243 </div>
244 <div class="memdoc">
245 <p>This function gets the <code>PP_URLRESPONSEPROPERTY_URL</code> property for the response. </p>
246 <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>
247 </div>
248 </div>
249 <hr />The documentation for this class was generated from the following file:<ul>
250 <li><a class="el" href="url__response__info_8h.html">url_response_info.h</a></li>
251 </ul>
252 </div><!-- contents -->
253 {{/partials.standard_nacl_article}}