|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
|
3 <title>TB10.1 Example Applications: CHttpClient Class Reference</title> |
|
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> |
|
5 <link href="tabs.css" rel="stylesheet" type="text/css"> |
|
6 </head><body> |
|
7 <!-- Generated by Doxygen 1.5.3 --> |
|
8 <h1>CHttpClient Class Reference</h1><!-- doxytag: class="CHttpClient" --> |
|
9 <p> |
|
10 <a href="class_c_http_client-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
11 <tr><td></td></tr> |
|
12 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
|
13 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33c02fb95218215e3289f560713597ce"></a><!-- doxytag: member="CHttpClient::~CHttpClient" ref="33c02fb95218215e3289f560713597ce" args="()" --> |
|
14 virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#33c02fb95218215e3289f560713597ce">~CHttpClient</a> ()</td></tr> |
|
15 |
|
16 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f39c19552deec488b5fa98fa9f9d929"></a><!-- doxytag: member="CHttpClient::StartClientL" ref="0f39c19552deec488b5fa98fa9f9d929" args="()" --> |
|
17 void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#0f39c19552deec488b5fa98fa9f9d929">StartClientL</a> ()</td></tr> |
|
18 |
|
19 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a296adbd23a0df0c7aacdee6d44b25f0"></a><!-- doxytag: member="CHttpClient::GetNextDataPart" ref="a296adbd23a0df0c7aacdee6d44b25f0" args="(TPtrC8 &aDataPart)" --> |
|
20 virtual TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#a296adbd23a0df0c7aacdee6d44b25f0">GetNextDataPart</a> (TPtrC8 &aDataPart)</td></tr> |
|
21 |
|
22 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9ebeda59a1c72795f56b84c18da6ae4"></a><!-- doxytag: member="CHttpClient::ReleaseData" ref="c9ebeda59a1c72795f56b84c18da6ae4" args="()" --> |
|
23 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#c9ebeda59a1c72795f56b84c18da6ae4">ReleaseData</a> ()</td></tr> |
|
24 |
|
25 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21f73ccc81e3025a99fc56b3d5cb3d1d"></a><!-- doxytag: member="CHttpClient::OverallDataSize" ref="21f73ccc81e3025a99fc56b3d5cb3d1d" args="()" --> |
|
26 virtual TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#21f73ccc81e3025a99fc56b3d5cb3d1d">OverallDataSize</a> ()</td></tr> |
|
27 |
|
28 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58dcb78f4fd957522ee44b42b721b021"></a><!-- doxytag: member="CHttpClient::Reset" ref="58dcb78f4fd957522ee44b42b721b021" args="()" --> |
|
29 virtual TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#58dcb78f4fd957522ee44b42b721b021">Reset</a> ()</td></tr> |
|
30 |
|
31 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#e154d7b4e42475225582afc5bde9c53a">GetCredentialsL</a> (const TUriC8 &aURI, RString aRealm, RStringF aAuthenticationType, RString &aUsername, RString &aPassword)</td></tr> |
|
32 |
|
33 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
|
34 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c629afd9dba45056a81a58be2a94a5c5"></a><!-- doxytag: member="CHttpClient::NewLC" ref="c629afd9dba45056a81a58be2a94a5c5" args="()" --> |
|
35 static <a class="el" href="class_c_http_client.html">CHttpClient</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#c629afd9dba45056a81a58be2a94a5c5">NewLC</a> ()</td></tr> |
|
36 |
|
37 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f62107c868da9904c92ffe6b726dc222"></a><!-- doxytag: member="CHttpClient::NewL" ref="f62107c868da9904c92ffe6b726dc222" args="()" --> |
|
38 static <a class="el" href="class_c_http_client.html">CHttpClient</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#f62107c868da9904c92ffe6b726dc222">NewL</a> ()</td></tr> |
|
39 |
|
40 <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
|
41 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="845a9f4ee99a401b8e5f719af489e970"></a><!-- doxytag: member="CHttpClient::CHttpClient" ref="845a9f4ee99a401b8e5f719af489e970" args="()" --> |
|
42 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#845a9f4ee99a401b8e5f719af489e970">CHttpClient</a> ()</td></tr> |
|
43 |
|
44 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38d577b3c8c8a3cd740e1b9be9224b91"></a><!-- doxytag: member="CHttpClient::ConstructL" ref="38d577b3c8c8a3cd740e1b9be9224b91" args="()" --> |
|
45 void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#38d577b3c8c8a3cd740e1b9be9224b91">ConstructL</a> ()</td></tr> |
|
46 |
|
47 </table> |
|
48 <hr><a name="_details"></a><h2>Detailed Description</h2> |
|
49 The example http client. Intended as a simple example of an http client. It is a simple text console app that allows basic http methods to be tested. It allows data for the post method to be supplied via a file or built up dynamically. It also allows responses to be saved to a file<p> |
|
50 It is derived from MHTTPAuthenticationCallback to allow access to servers that require a user to submit a username and password to access protected sections of that server. |
|
51 <p>Definition at line <a class="el" href="httpexampleclient_8h-source.html#l00048">48</a> of file <a class="el" href="httpexampleclient_8h-source.html">httpexampleclient.h</a>.</p> |
|
52 <hr><h2>Member Function Documentation</h2> |
|
53 <a class="anchor" name="e154d7b4e42475225582afc5bde9c53a"></a><!-- doxytag: member="CHttpClient::GetCredentialsL" ref="e154d7b4e42475225582afc5bde9c53a" args="(const TUriC8 &aURI, RString aRealm, RStringF aAuthenticationType, RString &aUsername, RString &aPassword)" --> |
|
54 <div class="memitem"> |
|
55 <div class="memproto"> |
|
56 <table class="memname"> |
|
57 <tr> |
|
58 <td class="memname">TBool CHttpClient::GetCredentialsL </td> |
|
59 <td>(</td> |
|
60 <td class="paramtype">const TUriC8 & </td> |
|
61 <td class="paramname"> <em>aURI</em>, </td> |
|
62 </tr> |
|
63 <tr> |
|
64 <td class="paramkey"></td> |
|
65 <td></td> |
|
66 <td class="paramtype">RString </td> |
|
67 <td class="paramname"> <em>aRealm</em>, </td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td class="paramkey"></td> |
|
71 <td></td> |
|
72 <td class="paramtype">RStringF </td> |
|
73 <td class="paramname"> <em>aAuthenticationType</em>, </td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td class="paramkey"></td> |
|
77 <td></td> |
|
78 <td class="paramtype">RString & </td> |
|
79 <td class="paramname"> <em>aUsername</em>, </td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td class="paramkey"></td> |
|
83 <td></td> |
|
84 <td class="paramtype">RString & </td> |
|
85 <td class="paramname"> <em>aPassword</em></td><td> </td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td></td> |
|
89 <td>)</td> |
|
90 <td></td><td></td><td width="100%"><code> [virtual]</code></td> |
|
91 </tr> |
|
92 </table> |
|
93 </div> |
|
94 <div class="memdoc"> |
|
95 |
|
96 <p> |
|
97 Called when a authenticated page is requested Asks the user for a username and password that would be appropriate for the url that was supplied. |
|
98 <p>Definition at line <a class="el" href="httpexampleclient_8cpp-source.html#l00402">402</a> of file <a class="el" href="httpexampleclient_8cpp-source.html">httpexampleclient.cpp</a>.</p> |
|
99 |
|
100 </div> |
|
101 </div><p> |
|
102 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:05 2010 for TB10.1 Example Applications by |
|
103 <a href="http://www.doxygen.org/index.html"> |
|
104 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
105 </body> |
|
106 </html> |