Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_client_engine_8h_source.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/ForumNokia/HTTPClientExample/inc/ClientEngine.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/ForumNokia/HTTPClientExample/inc/ClientEngine.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2009 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="preprocessor">#ifndef __CLIENTENGINE_H__</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="preprocessor">#define __CLIENTENGINE_H__</span>
<a name="l00007"></a>00007 <span class="preprocessor"></span>
<a name="l00008"></a>00008 <span class="preprocessor">#include <coecntrl.h></span>
<a name="l00009"></a>00009 <span class="preprocessor">#include <http\mhttpdatasupplier.h></span>
<a name="l00010"></a>00010 <span class="preprocessor">#include <http\mhttptransactioncallback.h></span>
<a name="l00011"></a>00011 <span class="preprocessor">#include <http\mhttpauthenticationcallback.h></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include <es_sock.h></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include <comms-infras/cs_mobility_apiext.h></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <cmapplicationsettingsui.h></span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="keyword">class </span>RHTTPSession;
<a name="l00017"></a>00017 <span class="keyword">class </span>RHTTPTransaction;
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="keyword">const</span> TInt KDefaultBufferSize = 256;
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">/*</span>
<a name="l00022"></a>00022 <span class="comment">* MClientObserver</span>
<a name="l00023"></a>00023 <span class="comment">* CClientEngine passes events and responses body data with this interface.</span>
<a name="l00024"></a>00024 <span class="comment">* An instance of this class must be provided for construction of CClientEngine.</span>
<a name="l00025"></a>00025 <span class="comment">*/</span>
<a name="l00026"></a><a class="code" href="class_m_client_observer.html">00026</a> <span class="keyword">class </span><a class="code" href="class_m_client_observer.html">MClientObserver</a>
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 <span class="keyword">public</span>:
<a name="l00029"></a>00029 <span class="comment">/*</span>
<a name="l00030"></a>00030 <span class="comment"> * ClientEvent()</span>
<a name="l00031"></a>00031 <span class="comment"> *</span>
<a name="l00032"></a>00032 <span class="comment"> * Called when event occurs in CClientEngine.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * Params:</span>
<a name="l00035"></a>00035 <span class="comment"> * aEventDescription: A event in textual format, e.g.</span>
<a name="l00036"></a>00036 <span class="comment"> * "Transaction Successful"</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * Returns:</span>
<a name="l00039"></a>00039 <span class="comment"> * -</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a>00042 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ClientEvent(<span class="keyword">const</span> TDesC& aEventDescription) = 0;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">/*</span>
<a name="l00045"></a>00045 <span class="comment"> * ClientBodyReceived()</span>
<a name="l00046"></a>00046 <span class="comment"> *</span>
<a name="l00047"></a>00047 <span class="comment"> * Called when a part of the HTTP body is received.</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * Params:</span>
<a name="l00050"></a>00050 <span class="comment"> * aBodyData: Part of the body data received. (e.g. part of</span>
<a name="l00051"></a>00051 <span class="comment"> * the received HTML page)</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * Returns:</span>
<a name="l00054"></a>00054 <span class="comment"> * -</span>
<a name="l00055"></a>00055 <span class="comment"> *</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ClientBodyReceived(<span class="keyword">const</span> TDesC8& aBodyData) = 0;
<a name="l00058"></a>00058 };
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">/*</span>
<a name="l00061"></a>00061 <span class="comment">* Provides simple interface to HTTP Client API.</span>
<a name="l00062"></a>00062 <span class="comment">*/</span>
<a name="l00063"></a><a class="code" href="class_c_client_engine.html">00063</a> <span class="keyword">class </span><a class="code" href="class_c_client_engine.html">CClientEngine</a> : <span class="keyword">public</span> CActive,
<a name="l00064"></a>00064 <span class="keyword">public</span> MHTTPTransactionCallback,
<a name="l00065"></a>00065 <span class="keyword">public</span> MHTTPDataSupplier,
<a name="l00066"></a>00066 <span class="keyword">public</span> MHTTPAuthenticationCallback,
<a name="l00067"></a>00067 <span class="keyword">public</span> MMobilityProtocolResp
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keyword">public</span>:
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">enum</span> EngineState
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 EIdle = 0,
<a name="l00074"></a>00074 EGet,
<a name="l00075"></a>00075 EPost
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">/*</span>
<a name="l00079"></a>00079 <span class="comment"> * NewL()</span>
<a name="l00080"></a>00080 <span class="comment"> *</span>
<a name="l00081"></a>00081 <span class="comment"> * Create a CClientEngine object.</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * Params:</span>
<a name="l00084"></a>00084 <span class="comment"> * iObserver:</span>
<a name="l00085"></a>00085 <span class="comment"> *</span>
<a name="l00086"></a>00086 <span class="comment"> * Returns:</span>
<a name="l00087"></a>00087 <span class="comment"> * A pointer to the created instance of CClientEngine</span>
<a name="l00088"></a>00088 <span class="comment"> *</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090 <span class="keyword">static</span> <a class="code" href="class_c_client_engine.html">CClientEngine</a>* NewL(<a class="code" href="class_m_client_observer.html">MClientObserver</a>& iObserver);
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="comment">/*</span>
<a name="l00093"></a>00093 <span class="comment"> * NewLC()</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * Create a CClientEngine object.</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> * Params:</span>
<a name="l00098"></a>00098 <span class="comment"> * iObserver:</span>
<a name="l00099"></a>00099 <span class="comment"> *</span>
<a name="l00100"></a>00100 <span class="comment"> * Returns:</span>
<a name="l00101"></a>00101 <span class="comment"> * A pointer to the created instance of CClientEngine</span>
<a name="l00102"></a>00102 <span class="comment"> *</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <span class="keyword">static</span> <a class="code" href="class_c_client_engine.html">CClientEngine</a>* NewLC(<a class="code" href="class_m_client_observer.html">MClientObserver</a>& iObserver);
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="comment">/*</span>
<a name="l00107"></a>00107 <span class="comment"> * ~CClientEngine()</span>
<a name="l00108"></a>00108 <span class="comment"> *</span>
<a name="l00109"></a>00109 <span class="comment"> * Destroy the object</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * Params:</span>
<a name="l00112"></a>00112 <span class="comment"> * -</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * Returns:</span>
<a name="l00115"></a>00115 <span class="comment"> * -</span>
<a name="l00116"></a>00116 <span class="comment"> *</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118 ~<a class="code" href="class_c_client_engine.html">CClientEngine</a>();
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">/*</span>
<a name="l00121"></a>00121 <span class="comment"> * IssueHTTPGetL()</span>
<a name="l00122"></a>00122 <span class="comment"> *</span>
<a name="l00123"></a>00123 <span class="comment"> * Starts a new HTTP GET transaction.</span>
<a name="l00124"></a>00124 <span class="comment"> *</span>
<a name="l00125"></a>00125 <span class="comment"> * Params:</span>
<a name="l00126"></a>00126 <span class="comment"> * aUri: URI to get. (e.g. http://host.org")</span>
<a name="l00127"></a>00127 <span class="comment"> *</span>
<a name="l00128"></a>00128 <span class="comment"> * Returns:</span>
<a name="l00129"></a>00129 <span class="comment"> * -</span>
<a name="l00130"></a>00130 <span class="comment"> *</span>
<a name="l00131"></a>00131 <span class="comment"> */</span>
<a name="l00132"></a>00132 <span class="keywordtype">void</span> IssueHTTPGetL(<span class="keyword">const</span> TDesC8& aUri);
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="comment">/*</span>
<a name="l00135"></a>00135 <span class="comment"> * IssueHTTPPostL()</span>
<a name="l00136"></a>00136 <span class="comment"> *</span>
<a name="l00137"></a>00137 <span class="comment"> * Starts a new HTTP POST transaction.</span>
<a name="l00138"></a>00138 <span class="comment"> *</span>
<a name="l00139"></a>00139 <span class="comment"> * Params:</span>
<a name="l00140"></a>00140 <span class="comment"> * aUri: URI where to post the data (e.g. http://host.org")</span>
<a name="l00141"></a>00141 <span class="comment"> * aContentType: Content type of the body, e.g. "text/plain"</span>
<a name="l00142"></a>00142 <span class="comment"> * aBody: Body data for the transaction.</span>
<a name="l00143"></a>00143 <span class="comment"> *</span>
<a name="l00144"></a>00144 <span class="comment"> * Returns:</span>
<a name="l00145"></a>00145 <span class="comment"> * -</span>
<a name="l00146"></a>00146 <span class="comment"> *</span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 <span class="keywordtype">void</span> IssueHTTPPostL(<span class="keyword">const</span> TDesC8& aUri,
<a name="l00149"></a>00149 <span class="keyword">const</span> TDesC8& aContentType,
<a name="l00150"></a>00150 <span class="keyword">const</span> TDesC8& aBody);
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="comment">/*</span>
<a name="l00153"></a>00153 <span class="comment"> * CancelTransaction()</span>
<a name="l00154"></a>00154 <span class="comment"> *</span>
<a name="l00155"></a>00155 <span class="comment"> * Closes currently running transaction and frees resources related to it.</span>
<a name="l00156"></a>00156 <span class="comment"> *</span>
<a name="l00157"></a>00157 <span class="comment"> * Params:</span>
<a name="l00158"></a>00158 <span class="comment"> * -</span>
<a name="l00159"></a>00159 <span class="comment"> *</span>
<a name="l00160"></a>00160 <span class="comment"> * Returns:</span>
<a name="l00161"></a>00161 <span class="comment"> * -</span>
<a name="l00162"></a>00162 <span class="comment"> *</span>
<a name="l00163"></a>00163 <span class="comment"> */</span>
<a name="l00164"></a>00164 <span class="keywordtype">void</span> CancelTransaction();
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">/*</span>
<a name="l00167"></a>00167 <span class="comment"> * IsRunning()</span>
<a name="l00168"></a>00168 <span class="comment"> *</span>
<a name="l00169"></a>00169 <span class="comment"> * Checks if the transaction is running.</span>
<a name="l00170"></a>00170 <span class="comment"> *</span>
<a name="l00171"></a>00171 <span class="comment"> * Params:</span>
<a name="l00172"></a>00172 <span class="comment"> * -</span>
<a name="l00173"></a>00173 <span class="comment"> *</span>
<a name="l00174"></a>00174 <span class="comment"> * Returns:</span>
<a name="l00175"></a>00175 <span class="comment"> * ETrue, if transaction is currently running.</span>
<a name="l00176"></a>00176 <span class="comment"> *</span>
<a name="l00177"></a>00177 <span class="comment"> */</span>
<a name="l00178"></a>00178 TBool IsRunning();
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">private</span>:
<a name="l00181"></a>00181 <span class="comment">/*</span>
<a name="l00182"></a>00182 <span class="comment"> * ConstructL()</span>
<a name="l00183"></a>00183 <span class="comment"> *</span>
<a name="l00184"></a>00184 <span class="comment"> * Perform the second phase construction of a CClientEngine object.</span>
<a name="l00185"></a>00185 <span class="comment"> *</span>
<a name="l00186"></a>00186 <span class="comment"> * Params:</span>
<a name="l00187"></a>00187 <span class="comment"> * -</span>
<a name="l00188"></a>00188 <span class="comment"> *</span>
<a name="l00189"></a>00189 <span class="comment"> * Returns:</span>
<a name="l00190"></a>00190 <span class="comment"> * -</span>
<a name="l00191"></a>00191 <span class="comment"> *</span>
<a name="l00192"></a>00192 <span class="comment"> */</span>
<a name="l00193"></a>00193 <span class="keywordtype">void</span> ConstructL();
<a name="l00194"></a>00194
<a name="l00195"></a>00195 <span class="comment">/*</span>
<a name="l00196"></a>00196 <span class="comment"> * CClientEngine()</span>
<a name="l00197"></a>00197 <span class="comment"> *</span>
<a name="l00198"></a>00198 <span class="comment"> * Perform the first phase of two phase construction.</span>
<a name="l00199"></a>00199 <span class="comment"> *</span>
<a name="l00200"></a>00200 <span class="comment"> * Params:</span>
<a name="l00201"></a>00201 <span class="comment"> * iObserver:</span>
<a name="l00202"></a>00202 <span class="comment"> *</span>
<a name="l00203"></a>00203 <span class="comment"> * Returns:</span>
<a name="l00204"></a>00204 <span class="comment"> * -</span>
<a name="l00205"></a>00205 <span class="comment"> *</span>
<a name="l00206"></a>00206 <span class="comment"> */</span>
<a name="l00207"></a>00207 <a class="code" href="class_c_client_engine.html">CClientEngine</a>(<a class="code" href="class_m_client_observer.html">MClientObserver</a>& iObserver);
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="comment">/*</span>
<a name="l00210"></a>00210 <span class="comment"> * SetHeaderL()</span>
<a name="l00211"></a>00211 <span class="comment"> *</span>
<a name="l00212"></a>00212 <span class="comment"> * Sets header value of an HTTP request.</span>
<a name="l00213"></a>00213 <span class="comment"> *</span>
<a name="l00214"></a>00214 <span class="comment"> * Params:</span>
<a name="l00215"></a>00215 <span class="comment"> * aHeaders: Headers of the HTTP request</span>
<a name="l00216"></a>00216 <span class="comment"> * aHdrField: Enumerated HTTP header field, e.g. HTTP::EUserAgent</span>
<a name="l00217"></a>00217 <span class="comment"> * aHdrValue: New value for header field</span>
<a name="l00218"></a>00218 <span class="comment"> *</span>
<a name="l00219"></a>00219 <span class="comment"> * Returns:</span>
<a name="l00220"></a>00220 <span class="comment"> * -</span>
<a name="l00221"></a>00221 <span class="comment"> *</span>
<a name="l00222"></a>00222 <span class="comment"> */</span>
<a name="l00223"></a>00223 <span class="keywordtype">void</span> SetHeaderL(RHTTPHeaders aHeaders, TInt aHdrField,
<a name="l00224"></a>00224 <span class="keyword">const</span> TDesC8& aHdrValue);
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="keywordtype">void</span> SetupConnectionL();
<a name="l00227"></a>00227
<a name="l00231"></a>00231 TBool CClientEngine::FindExistingConnection();
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="comment">/*</span>
<a name="l00234"></a>00234 <span class="comment">* From MHTTPSessionEventCallback</span>
<a name="l00235"></a>00235 <span class="comment">*/</span>
<a name="l00236"></a>00236 <span class="keyword">private</span>:
<a name="l00237"></a>00237 <span class="comment">/*</span>
<a name="l00238"></a>00238 <span class="comment"> * MHFRunL()</span>
<a name="l00239"></a>00239 <span class="comment"> *</span>
<a name="l00240"></a>00240 <span class="comment"> * Called by framework to notify about transaction events.</span>
<a name="l00241"></a>00241 <span class="comment"> *</span>
<a name="l00242"></a>00242 <span class="comment"> * Params:</span>
<a name="l00243"></a>00243 <span class="comment"> * aTransaction: Transaction, where the event occured.</span>
<a name="l00244"></a>00244 <span class="comment"> * aEvent: Occured event.</span>
<a name="l00245"></a>00245 <span class="comment"> *</span>
<a name="l00246"></a>00246 <span class="comment"> * Returns:</span>
<a name="l00247"></a>00247 <span class="comment"> * -</span>
<a name="l00248"></a>00248 <span class="comment"> *</span>
<a name="l00249"></a>00249 <span class="comment"> */</span>
<a name="l00250"></a>00250 <span class="keywordtype">void</span> MHFRunL(RHTTPTransaction aTransaction, <span class="keyword">const</span> THTTPEvent& aEvent);
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="comment">/*</span>
<a name="l00253"></a>00253 <span class="comment"> * MHFRunError()</span>
<a name="l00254"></a>00254 <span class="comment"> *</span>
<a name="l00255"></a>00255 <span class="comment"> * Called by framework when *leave* occurs in handling of transaction event.</span>
<a name="l00256"></a>00256 <span class="comment"> *</span>
<a name="l00257"></a>00257 <span class="comment"> * Params:</span>
<a name="l00258"></a>00258 <span class="comment"> * aError: The leave code that occured.</span>
<a name="l00259"></a>00259 <span class="comment"> * aTransaction: The transaction that was being processed when leave</span>
<a name="l00260"></a>00260 <span class="comment"> * occured.</span>
<a name="l00261"></a>00261 <span class="comment"> * aEvent: The event that was being processed when leave</span>
<a name="l00262"></a>00262 <span class="comment"> * occured.</span>
<a name="l00263"></a>00263 <span class="comment"> *</span>
<a name="l00264"></a>00264 <span class="comment"> * Returns:</span>
<a name="l00265"></a>00265 <span class="comment"> * KErrNone, if the error was handled. Otherwise the value of aError, or</span>
<a name="l00266"></a>00266 <span class="comment"> * some other error value. Returning error value causes causes</span>
<a name="l00267"></a>00267 <span class="comment"> * HTTP-CORE 6 panic.</span>
<a name="l00268"></a>00268 <span class="comment"> *</span>
<a name="l00269"></a>00269 <span class="comment"> */</span>
<a name="l00270"></a>00270 TInt MHFRunError( TInt aError,
<a name="l00271"></a>00271 RHTTPTransaction aTransaction,
<a name="l00272"></a>00272 <span class="keyword">const</span> THTTPEvent& aEvent);
<a name="l00273"></a>00273
<a name="l00274"></a>00274 <span class="comment">/*</span>
<a name="l00275"></a>00275 <span class="comment">* From MHTTPDataSupplier (needed for HTTP POST)</span>
<a name="l00276"></a>00276 <span class="comment">*/</span>
<a name="l00277"></a>00277 <span class="keyword">private</span>:
<a name="l00278"></a>00278 <span class="comment">/*</span>
<a name="l00279"></a>00279 <span class="comment"> * ReleaseData()</span>
<a name="l00280"></a>00280 <span class="comment"> *</span>
<a name="l00281"></a>00281 <span class="comment"> * Called by framework to allow data supplier to release resources</span>
<a name="l00282"></a>00282 <span class="comment"> * related to previous data part.</span>
<a name="l00283"></a>00283 <span class="comment"> *</span>
<a name="l00284"></a>00284 <span class="comment"> * Params:</span>
<a name="l00285"></a>00285 <span class="comment"> * -</span>
<a name="l00286"></a>00286 <span class="comment"> *</span>
<a name="l00287"></a>00287 <span class="comment"> * Returns:</span>
<a name="l00288"></a>00288 <span class="comment"> * -</span>
<a name="l00289"></a>00289 <span class="comment"> *</span>
<a name="l00290"></a>00290 <span class="comment"> */</span>
<a name="l00291"></a>00291 <span class="keywordtype">void</span> ReleaseData();
<a name="l00292"></a>00292
<a name="l00293"></a>00293 <span class="comment">/*</span>
<a name="l00294"></a>00294 <span class="comment"> * GetNextDataPart()</span>
<a name="l00295"></a>00295 <span class="comment"> *</span>
<a name="l00296"></a>00296 <span class="comment"> * Called when next data part is needed.</span>
<a name="l00297"></a>00297 <span class="comment"> *</span>
<a name="l00298"></a>00298 <span class="comment"> * Params:</span>
<a name="l00299"></a>00299 <span class="comment"> * aDataPart: Must be set to point to the next data part.</span>
<a name="l00300"></a>00300 <span class="comment"> *</span>
<a name="l00301"></a>00301 <span class="comment"> * Returns:</span>
<a name="l00302"></a>00302 <span class="comment"> * ETrue if the provided data part is the last one. If more data parts</span>
<a name="l00303"></a>00303 <span class="comment"> * are needed after the provided one, return EFalse.</span>
<a name="l00304"></a>00304 <span class="comment"> *</span>
<a name="l00305"></a>00305 <span class="comment"> */</span>
<a name="l00306"></a>00306 TBool GetNextDataPart(TPtrC8& aDataPart);
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="comment">/*</span>
<a name="l00309"></a>00309 <span class="comment"> * Reset()</span>
<a name="l00310"></a>00310 <span class="comment"> *</span>
<a name="l00311"></a>00311 <span class="comment"> * Called by framework to reset the data supplier to its initial state.</span>
<a name="l00312"></a>00312 <span class="comment"> *</span>
<a name="l00313"></a>00313 <span class="comment"> * Params:</span>
<a name="l00314"></a>00314 <span class="comment"> * -</span>
<a name="l00315"></a>00315 <span class="comment"> *</span>
<a name="l00316"></a>00316 <span class="comment"> * Returns:</span>
<a name="l00317"></a>00317 <span class="comment"> * KErrNone if successfull.</span>
<a name="l00318"></a>00318 <span class="comment"> *</span>
<a name="l00319"></a>00319 <span class="comment"> */</span>
<a name="l00320"></a>00320 TInt Reset();
<a name="l00321"></a>00321
<a name="l00322"></a>00322 <span class="comment">/*</span>
<a name="l00323"></a>00323 <span class="comment"> * OverallDataSize()</span>
<a name="l00324"></a>00324 <span class="comment"> *</span>
<a name="l00325"></a>00325 <span class="comment"> * Called by framework when it needs to know the size of the</span>
<a name="l00326"></a>00326 <span class="comment"> * body data.</span>
<a name="l00327"></a>00327 <span class="comment"> *</span>
<a name="l00328"></a>00328 <span class="comment"> * Params:</span>
<a name="l00329"></a>00329 <span class="comment"> * -</span>
<a name="l00330"></a>00330 <span class="comment"> *</span>
<a name="l00331"></a>00331 <span class="comment"> * Returns:</span>
<a name="l00332"></a>00332 <span class="comment"> * Size of the data, or KErrNotFound (or KErrNotSupported)</span>
<a name="l00333"></a>00333 <span class="comment"> * if the size of the data is not known.</span>
<a name="l00334"></a>00334 <span class="comment"> *</span>
<a name="l00335"></a>00335 <span class="comment"> */</span>
<a name="l00336"></a>00336 TInt OverallDataSize();
<a name="l00337"></a>00337
<a name="l00338"></a>00338 <span class="comment">/*</span>
<a name="l00339"></a>00339 <span class="comment">* From MHTTPAuthenticationCallback (needed for HTTP authentication)</span>
<a name="l00340"></a>00340 <span class="comment">*/</span>
<a name="l00341"></a>00341 <span class="keyword">private</span>:
<a name="l00342"></a>00342 <span class="comment">/*</span>
<a name="l00343"></a>00343 <span class="comment"> * GetCredentialsL()</span>
<a name="l00344"></a>00344 <span class="comment"> *</span>
<a name="l00345"></a>00345 <span class="comment"> * Called by framework when username and password for requested URI is</span>
<a name="l00346"></a>00346 <span class="comment"> * needed.</span>
<a name="l00347"></a>00347 <span class="comment"> *</span>
<a name="l00348"></a>00348 <span class="comment"> * Params:</span>
<a name="l00349"></a>00349 <span class="comment"> * aURI: The URI being requested (e.g. "http://host.org")</span>
<a name="l00350"></a>00350 <span class="comment"> * aRealm: The realm being requested (e.g. "user@host.org")</span>
<a name="l00351"></a>00351 <span class="comment"> * aAuthenticationType: Authentication type. (e.g. "Basic")</span>
<a name="l00352"></a>00352 <span class="comment"> * aUsername: Given user name.</span>
<a name="l00353"></a>00353 <span class="comment"> * aPassword: Given password.</span>
<a name="l00354"></a>00354 <span class="comment"> *</span>
<a name="l00355"></a>00355 <span class="comment"> * Returns:</span>
<a name="l00356"></a>00356 <span class="comment"> * A pointer to the created document</span>
<a name="l00357"></a>00357 <span class="comment"> *</span>
<a name="l00358"></a>00358 <span class="comment"> */</span>
<a name="l00359"></a>00359 TBool GetCredentialsL( <span class="keyword">const</span> TUriC8& aURI,
<a name="l00360"></a>00360 RString aRealm,
<a name="l00361"></a>00361 RStringF aAuthenticationType,
<a name="l00362"></a>00362 RString& aUsername,
<a name="l00363"></a>00363 RString& aPassword);
<a name="l00364"></a>00364
<a name="l00365"></a>00365
<a name="l00366"></a>00366 <span class="keyword">private</span>: <span class="comment">// from MMobilityProtocolResp</span>
<a name="l00367"></a>00367 <span class="keywordtype">void</span> PreferredCarrierAvailable(TAccessPointInfo aOldAPInfo,
<a name="l00368"></a>00368 TAccessPointInfo aNewAPInfo,
<a name="l00369"></a>00369 TBool aIsUpgrade,
<a name="l00370"></a>00370 TBool aIsSeamless);
<a name="l00371"></a>00371 <span class="keywordtype">void</span> NewCarrierActive(TAccessPointInfo aNewAPInfo, TBool aIsSeamless);
<a name="l00372"></a>00372 <span class="keywordtype">void</span> Error(TInt aError);
<a name="l00373"></a>00373
<a name="l00374"></a>00374 <span class="keyword">private</span>: <span class="comment">// from CActive</span>
<a name="l00375"></a>00375 <span class="keywordtype">void</span> RunL();
<a name="l00376"></a>00376 <span class="keywordtype">void</span> DoCancel();
<a name="l00377"></a>00377
<a name="l00378"></a>00378 <span class="keyword">private</span>:
<a name="l00379"></a>00379 <span class="keywordtype">void</span> DoHTTPGetL();
<a name="l00380"></a>00380 <span class="keywordtype">void</span> DoHTTPPostL();
<a name="l00381"></a>00381
<a name="l00382"></a>00382 <span class="keyword">private</span>:
<a name="l00383"></a>00383 <span class="comment">// declare members</span>
<a name="l00384"></a>00384 RSocketServ iSocketServ;
<a name="l00385"></a>00385 RConnection iConnection;
<a name="l00386"></a>00386 TUint32 iSelectedIap;
<a name="l00387"></a>00387
<a name="l00388"></a>00388 RHTTPSession iSession;
<a name="l00389"></a>00389 RHTTPTransaction iTransaction;
<a name="l00390"></a>00390
<a name="l00391"></a>00391 <a class="code" href="class_m_client_observer.html">MClientObserver</a>& iObserver; <span class="comment">// Used for passing body data and events to UI</span>
<a name="l00392"></a>00392 HBufC8* iPostData; <span class="comment">// Data for HTTP POST</span>
<a name="l00393"></a>00393 TBool iRunning; <span class="comment">// ETrue, if transaction running</span>
<a name="l00394"></a>00394 TBool iConnectionSetupDone;
<a name="l00395"></a>00395
<a name="l00396"></a>00396 TInt iPrevProfileId;
<a name="l00397"></a>00397
<a name="l00398"></a>00398 CActiveCommsMobilityApiExt* iMobility;
<a name="l00399"></a>00399 TBool iTransactionOpen;
<a name="l00400"></a>00400 EngineState iEngineState;
<a name="l00401"></a>00401 HBufC8* iUri;
<a name="l00402"></a>00402 HBufC8* iContentType;
<a name="l00403"></a>00403 HBufC8* iBody;
<a name="l00404"></a>00404
<a name="l00405"></a>00405
<a name="l00406"></a>00406 };
<a name="l00407"></a>00407
<a name="l00408"></a>00408 <span class="preprocessor">#endif // __CLIENTENGINE_H__</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>