?? _web_client_engine_8h-source.html
字號:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>WebClientEngine.h Source File</title><link href="style.css" rel="stylesheet" type="text/css"></head><table border="0" width="100%" height="8" bgcolor="#eeeeee"> <tr> <td width="100%" height="1"><b><font size="2" color="#000000" face="Arial, Helvetica, sans-serif"><strong><a name=Top></a> S60 3rd Edition SDK for Symbian OS </strong></font></b><br><i>Example Applications Guide</i></td></tr> </table><!-- Generated by Doxygen 1.4.5 --><h1>WebClientEngine.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">* ==============================================================================</span><a name="l00003"></a>00003 <span class="comment">* Name : WebClientEngine.h</span><a name="l00004"></a>00004 <span class="comment">* Part of : WebClient</span><a name="l00005"></a>00005 <span class="comment">* Interface : </span><a name="l00006"></a>00006 <span class="comment">* Description : </span><a name="l00007"></a>00007 <span class="comment">* Version : </span><a name="l00008"></a>00008 <span class="comment">*</span><a name="l00009"></a>00009 <span class="comment">* Copyright (c) 2005-2006 Nokia Corporation.</span><a name="l00010"></a>00010 <span class="comment">* This material, including documentation and any related </span><a name="l00011"></a>00011 <span class="comment">* computer programs, is protected by copyright controlled by </span><a name="l00012"></a>00012 <span class="comment">* Nokia Corporation.</span><a name="l00013"></a>00013 <span class="comment">* ==============================================================================</span><a name="l00014"></a>00014 <span class="comment">*/</span><a name="l00015"></a>00015 <a name="l00016"></a>00016 <span class="preprocessor">#ifndef WEBCLIENTENGINE_H</span><a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define WEBCLIENTENGINE_H</span><a name="l00018"></a>00018 <span class="preprocessor"></span><a name="l00019"></a>00019 <span class="comment">// INCLUDES</span><a name="l00020"></a>00020 <span class="preprocessor">#include <coecntrl.h></span><a name="l00021"></a>00021 <span class="preprocessor">#include <http.h></span><a name="l00022"></a>00022 <span class="preprocessor">#include <http\mhttpauthenticationcallback.h></span><a name="l00023"></a>00023 <a name="l00025"></a>00025 <span class="keyword">const</span> TInt KMaxHeaderNameLength = 32;<a name="l00026"></a>00026 <span class="keyword">const</span> TInt KMaxHeaderValueLength = 128;<a name="l00027"></a>00027 <span class="keyword">const</span> TInt KMaxAuthTypeLength = 128;<a name="l00028"></a>00028 <span class="keyword">const</span> TInt KMaxDateTimeStringLength = 40;<a name="l00029"></a>00029 <span class="keyword">const</span> TInt KMaxStatusTextLength = 32;<a name="l00030"></a>00030 <a name="l00031"></a>00031 <span class="comment">// Used user agent for requests</span><a name="l00032"></a>00032 _LIT8( KUserAgent, <span class="stringliteral">"WebClient 1.0"</span> );<a name="l00033"></a>00033 <a name="l00034"></a>00034 <span class="comment">// This client accepts all content types.</span><a name="l00035"></a>00035 <span class="comment">// (change to e.g. "text/plain" for plain text only)</span><a name="l00037"></a>00037 <a name="l00038"></a>00038 <span class="comment">// Format for output of data/time values</span><a name="l00039"></a>00039 _LIT( KDateFormat,<span class="stringliteral">"%D%M%Y%/0%1%/1%2%/2%3%/3 %:0%H%:1%T%:2%S.%C%:3"</span> );<a name="l00040"></a>00040 <a name="l00041"></a>00041 <span class="comment">// Some texts for header output</span><a name="l00042"></a>00042 _LIT( KColon, <span class="stringliteral">": "</span> );<a name="l00043"></a>00043 _LIT( Krealm, <span class="stringliteral">"Realm: "</span> );<a name="l00044"></a>00044 <a name="l00045"></a>00045 <a name="l00046"></a>00046 <span class="comment">// FORWARD DECLARATIONS</span><a name="l00047"></a>00047 <span class="keyword">class </span><a class="code" href="class_c_web_client_app_ui.html">CWebClientAppUi</a>;<a name="l00048"></a>00048 <a name="l00049"></a>00049 <span class="comment">// CLASS DECLARATION</span><a name="l00050"></a>00050 <span class="comment"></span><a name="l00051"></a>00051 <span class="comment">/**</span><a name="l00052"></a>00052 <span class="comment">* MWebClientObserver</span><a name="l00053"></a>00053 <span class="comment">* CWebClientEngine passes events and responses body data with this interface. </span><a name="l00054"></a>00054 <span class="comment">* An instance of this class must be provided for construction of CWebClientEngine.</span><a name="l00055"></a>00055 <span class="comment">*/</span><a name="l00056"></a><a class="code" href="class_m_web_client_observer.html">00056</a> <span class="keyword">class </span><a class="code" href="class_m_web_client_observer.html">MWebClientObserver</a> <a name="l00057"></a>00057 {<a name="l00058"></a>00058 <span class="keyword">public</span>:<span class="comment"></span><a name="l00059"></a>00059 <span class="comment"> /**</span><a name="l00060"></a>00060 <span class="comment"> * ClientEvent()</span><a name="l00061"></a>00061 <span class="comment"> * Called when event occurs in CWebClientEngine.</span><a name="l00062"></a>00062 <span class="comment"> * @param aEventDescription: A event in textual format, e.g.</span><a name="l00063"></a>00063 <span class="comment"> * "Transaction Successful"</span><a name="l00064"></a>00064 <span class="comment"> */</span><a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_web_client_observer.html#ba45586e3b6414e9a001aa362b83f6d3">ClientEvent</a>( <span class="keyword">const</span> TDesC& aEventDescription ) = 0;<a name="l00066"></a>00066 <a name="l00067"></a>00067 <span class="keyword">public</span>:<span class="comment"></span><a name="l00068"></a>00068 <span class="comment"> /**</span><a name="l00069"></a>00069 <span class="comment"> * ClientHeaderReceived()</span><a name="l00070"></a>00070 <span class="comment"> * Called when HTTP header is received.</span><a name="l00071"></a>00071 <span class="comment"> * @param aHeaderData: Header field name and value</span><a name="l00072"></a>00072 <span class="comment"> */</span><a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_web_client_observer.html#7d090b7f3f592086c7c057ff92d0e69a">ClientHeaderReceived</a>( <span class="keyword">const</span> TDesC& aHeaderData ) = 0;<a name="l00074"></a>00074 <span class="comment"></span><a name="l00075"></a>00075 <span class="comment"> /**</span><a name="l00076"></a>00076 <span class="comment"> * ClientBodyReceived()</span><a name="l00077"></a>00077 <span class="comment"> * Called when a part of the HTTP body is received.</span><a name="l00078"></a>00078 <span class="comment"> * @param aBodyData: Part of the body data received. (e.g. part of</span><a name="l00079"></a>00079 <span class="comment"> * the received HTML page)</span><a name="l00080"></a>00080 <span class="comment"> */</span><a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_web_client_observer.html#50e49839449e3e1580d570d67eb956e8">ClientBodyReceived</a>( <span class="keyword">const</span> TDesC8& aBodyData ) = 0;<a name="l00082"></a>00082 };<a name="l00083"></a>00083 <span class="comment"></span><a name="l00084"></a>00084 <span class="comment">/**</span><a name="l00085"></a>00085 <span class="comment">* CWebClientEngine</span><a name="l00086"></a>00086 <span class="comment">* Provides simple interface to HTTP Client API.</span><a name="l00087"></a>00087 <span class="comment">*/</span><a name="l00088"></a><a class="code" href="class_c_web_client_engine.html">00088</a> <span class="keyword">class </span><a class="code" href="class_c_web_client_engine.html">CWebClientEngine</a> : <span class="keyword">public</span> CBase, <a name="l00089"></a>00089 <span class="keyword">public</span> MHTTPTransactionCallback,<a name="l00090"></a>00090 <span class="keyword">public</span> MHTTPAuthenticationCallback<a name="l00091"></a>00091 {<a name="l00092"></a>00092 <span class="keyword">public</span>:<span class="comment"></span><a name="l00093"></a>00093 <span class="comment"> /**</span><a name="l00094"></a>00094 <span class="comment"> * NewL()</span><a name="l00095"></a>00095 <span class="comment"> * Create a CWebClientEngine object.</span><a name="l00096"></a>00096 <span class="comment"> * @param iObserver: </span><a name="l00097"></a>00097 <span class="comment"> * @return A pointer to the created instance of CWebClientEngine</span><a name="l00098"></a>00098 <span class="comment"> */</span><a name="l00099"></a>00099 <span class="keyword">static</span> <a class="code" href="class_c_web_client_engine.html">CWebClientEngine</a>* <a class="code" href="class_c_web_client_engine.html#b264d72c4ee8a9aec87d89eda84d2ef7">NewL</a>( <a class="code" href="class_m_web_client_observer.html">MWebClientObserver</a>& aObserver );<a name="l00100"></a>00100 <span class="comment"></span><a name="l00101"></a>00101 <span class="comment"> /**</span><a name="l00102"></a>00102 <span class="comment"> * NewLC()</span><a name="l00103"></a>00103 <span class="comment"> * Create a CWebClientEngine object.</span><a name="l00104"></a>00104 <span class="comment"> * @param iObserver:</span><a name="l00105"></a>00105 <span class="comment"> * @return A pointer to the created instance of CWebClientEngine</span><a name="l00106"></a>00106 <span class="comment"> */</span><a name="l00107"></a>00107 <span class="keyword">static</span> <a class="code" href="class_c_web_client_engine.html">CWebClientEngine</a>* <a class="code" href="class_c_web_client_engine.html#57e22c490455b0b11d8c35b54c4abb61">NewLC</a>( <a class="code" href="class_m_web_client_observer.html">MWebClientObserver</a>& aObserver );<a name="l00108"></a>00108 <span class="comment"></span><a name="l00109"></a>00109 <span class="comment"> /**</span><a name="l00110"></a>00110 <span class="comment"> * ~CWebClientEngine()</span><a name="l00111"></a>00111 <span class="comment"> * Destroy the object</span><a name="l00112"></a>00112 <span class="comment"> */</span><a name="l00113"></a>00113 <a class="code" href="class_c_web_client_engine.html#6b11939584e352b78a736b2f411623c2">~CWebClientEngine</a>();<a name="l00114"></a>00114 <span class="comment"></span><a name="l00115"></a>00115 <span class="comment"> /**</span><a name="l00116"></a>00116 <span class="comment"> * IssueHTTPGetL()</span><a name="l00117"></a>00117 <span class="comment"> * Starts a new HTTP GET transaction.</span><a name="l00118"></a>00118 <span class="comment"> * @param aUri: URI to get. (e.g. http://host.org")</span><a name="l00119"></a>00119 <span class="comment"> */</span><a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="class_c_web_client_engine.html#b0657f50d2303b5a4f15a7c3b15cbbdc">IssueHTTPGetL</a>( <span class="keyword">const</span> TDesC8& aUri );<a name="l00121"></a>00121 <span class="comment"></span><a name="l00122"></a>00122 <span class="comment"> /**</span><a name="l00123"></a>00123 <span class="comment"> * CancelTransactionL()</span><a name="l00124"></a>00124 <span class="comment"> * Closes currently running transaction and frees resources related to it.</span>?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -