Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_http_client.html
week 10 bug fix submission: Bug 1892, Bug 1897, Bug 1319. Also 3 or 4 documents were found to contain code blocks with SFL, which has been fixed. Partial fix for broken links, links to Forum Nokia, and the 'Symbian platform' terminology issues.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CHttpClient Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CHttpClient Class Reference</h1><!-- doxytag: class="CHttpClient" -->
<p>
<a href="class_c_http_client-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33c02fb95218215e3289f560713597ce"></a><!-- doxytag: member="CHttpClient::~CHttpClient" ref="33c02fb95218215e3289f560713597ce" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#33c02fb95218215e3289f560713597ce">~CHttpClient</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f39c19552deec488b5fa98fa9f9d929"></a><!-- doxytag: member="CHttpClient::StartClientL" ref="0f39c19552deec488b5fa98fa9f9d929" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#0f39c19552deec488b5fa98fa9f9d929">StartClientL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a296adbd23a0df0c7aacdee6d44b25f0"></a><!-- doxytag: member="CHttpClient::GetNextDataPart" ref="a296adbd23a0df0c7aacdee6d44b25f0" args="(TPtrC8 &aDataPart)" -->
virtual TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#a296adbd23a0df0c7aacdee6d44b25f0">GetNextDataPart</a> (TPtrC8 &aDataPart)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9ebeda59a1c72795f56b84c18da6ae4"></a><!-- doxytag: member="CHttpClient::ReleaseData" ref="c9ebeda59a1c72795f56b84c18da6ae4" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#c9ebeda59a1c72795f56b84c18da6ae4">ReleaseData</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21f73ccc81e3025a99fc56b3d5cb3d1d"></a><!-- doxytag: member="CHttpClient::OverallDataSize" ref="21f73ccc81e3025a99fc56b3d5cb3d1d" args="()" -->
virtual TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#21f73ccc81e3025a99fc56b3d5cb3d1d">OverallDataSize</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58dcb78f4fd957522ee44b42b721b021"></a><!-- doxytag: member="CHttpClient::Reset" ref="58dcb78f4fd957522ee44b42b721b021" args="()" -->
virtual TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#58dcb78f4fd957522ee44b42b721b021">Reset</a> ()</td></tr>
<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>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c629afd9dba45056a81a58be2a94a5c5"></a><!-- doxytag: member="CHttpClient::NewLC" ref="c629afd9dba45056a81a58be2a94a5c5" args="()" -->
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>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f62107c868da9904c92ffe6b726dc222"></a><!-- doxytag: member="CHttpClient::NewL" ref="f62107c868da9904c92ffe6b726dc222" args="()" -->
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>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="845a9f4ee99a401b8e5f719af489e970"></a><!-- doxytag: member="CHttpClient::CHttpClient" ref="845a9f4ee99a401b8e5f719af489e970" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#845a9f4ee99a401b8e5f719af489e970">CHttpClient</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38d577b3c8c8a3cd740e1b9be9224b91"></a><!-- doxytag: member="CHttpClient::ConstructL" ref="38d577b3c8c8a3cd740e1b9be9224b91" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_http_client.html#38d577b3c8c8a3cd740e1b9be9224b91">ConstructL</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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>
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.
<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>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e154d7b4e42475225582afc5bde9c53a"></a><!-- doxytag: member="CHttpClient::GetCredentialsL" ref="e154d7b4e42475225582afc5bde9c53a" args="(const TUriC8 &aURI, RString aRealm, RStringF aAuthenticationType, RString &aUsername, RString &aPassword)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CHttpClient::GetCredentialsL </td>
<td>(</td>
<td class="paramtype">const TUriC8 & </td>
<td class="paramname"> <em>aURI</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RString </td>
<td class="paramname"> <em>aRealm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RStringF </td>
<td class="paramname"> <em>aAuthenticationType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RString & </td>
<td class="paramname"> <em>aUsername</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RString & </td>
<td class="paramname"> <em>aPassword</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<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>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:05 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>