Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_task_manager_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/Symbian_OS_End-to-End_Sockets_API_Example/SocketTaskManager_S60/inc/TaskManagerEngine.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/Symbian_OS_End-to-End_Sockets_API_Example/SocketTaskManager_S60/inc/TaskManagerEngine.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 : CTaskManagerEngine from TaskManagerEngine.h</span>
<a name="l00004"></a>00004 <span class="comment">* Part of : TaskManager</span>
<a name="l00005"></a>00005 <span class="comment">* Created : 15/03/2006 by Forum Nokia</span>
<a name="l00006"></a>00006 <span class="comment">* Version : 1.2</span>
<a name="l00007"></a>00007 <span class="comment">* Copyright: Nokia Corporation</span>
<a name="l00008"></a>00008 <span class="comment">* ============================================================================</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="preprocessor">#ifndef __TASKMANAGERENGINE_H</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define __TASKMANAGERENGINE_H</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span>
<a name="l00014"></a>00014 <span class="comment">// INCLUDE FILES</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include "TaskManager.hrh"</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include "TaskManagerEngineReader.h"</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include "timeouttimer.h"</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include "request.h"</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#include <in_sock.h></span> <span class="comment">//TInetAddr</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <msvapi.h></span> <span class="comment">//MMsvSessionObserver</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <cdblen.h></span> <span class="comment">//KCommsDbSvrMaxFieldLength</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <es_sock.h></span> <span class="comment">//TSockXfrLength</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// FORWARD DECLARATIONS</span>
<a name="l00026"></a>00026 <span class="keyword">class </span>CSecureSocket;
<a name="l00027"></a>00027 <span class="keyword">class </span><a class="code" href="class_c_response.html">CResponse</a>;
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// CLASS DECLARATION</span>
<a name="l00030"></a>00030
<a name="l00034"></a><a class="code" href="class_m_transaction_observer.html">00034</a> <span class="keyword">class </span><a class="code" href="class_m_transaction_observer.html">MTransactionObserver</a>
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00040"></a>00040 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_transaction_observer.html#a81df9d3e254a9f0b09d04fedbd32f063">OpeningConnectionL</a>() = 0;
<a name="l00041"></a>00041
<a name="l00046"></a>00046 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_transaction_observer.html#abdb774e645bfd76beacc43ac3f033219">SuccessL</a>(<span class="keyword">const</span> <a class="code" href="class_c_response.html">CResponse</a>& aResponse) = 0;
<a name="l00047"></a>00047
<a name="l00052"></a>00052 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_transaction_observer.html#a781e451fe90e8678793278279d37d5f0">FailedL</a>(<span class="keyword">const</span> TInt& aError) = 0;
<a name="l00053"></a>00053
<a name="l00058"></a>00058 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_transaction_observer.html#acc250172c2e57609e2993bfea1214d37">ConnectingToServerL</a>(<span class="keyword">const</span> TBool& aLoadingTasks) = 0;
<a name="l00059"></a>00059
<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_transaction_observer.html#a181d92273f185c382c95eb84deaf877c">CancelledL</a>() = 0;
<a name="l00064"></a>00064
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_m_transaction_observer.html#ae487a3f2e816de373c20da0b56edc407">ErrorL</a>(<span class="keyword">const</span> TDesC& aErrorMsg) = 0;
<a name="l00071"></a>00071 };
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">// CLASS DECLARATION</span>
<a name="l00074"></a>00074
<a name="l00078"></a><a class="code" href="class_t_iap.html">00078</a> <span class="keyword">class </span><a class="code" href="class_t_iap.html">TIap</a>
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 <span class="keyword">public</span>:
<a name="l00081"></a>00081 TUint32 iId;
<a name="l00082"></a>00082 TBuf<KCommsDbSvrMaxFieldLength> iName;
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// CLASS DECLARATION</span>
<a name="l00087"></a>00087
<a name="l00093"></a><a class="code" href="class_c_task_manager_engine.html">00093</a> <span class="keyword">class </span><a class="code" href="class_c_task_manager_engine.html">CTaskManagerEngine</a> : <span class="keyword">public</span> CActive,
<a name="l00094"></a>00094 <span class="keyword">public</span> MMsvSessionObserver,
<a name="l00095"></a>00095 <span class="keyword">public</span> <a class="code" href="class_m_engine_notifier.html">MEngineNotifier</a>,
<a name="l00096"></a>00096 <span class="keyword">public</span> <a class="code" href="class_m_timeout_notifier.html">MTimeoutNotifier</a>
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keyword">public</span>: <span class="comment">// Constructors and destructor</span>
<a name="l00099"></a>00099
<a name="l00103"></a>00103 <span class="keyword">static</span> <a class="code" href="class_c_task_manager_engine.html">CTaskManagerEngine</a>* <a class="code" href="class_c_task_manager_engine.html#a048ea3e52e18a4c300d4d79d1dc2c247">NewL</a>(<a class="code" href="class_m_transaction_observer.html">MTransactionObserver</a>& aObserver);
<a name="l00104"></a>00104
<a name="l00108"></a>00108 <a class="code" href="class_c_task_manager_engine.html#a266a60f9e39fc2c976c2b26c23550190">~CTaskManagerEngine</a>();
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">protected</span>: <span class="comment">// from CActive</span>
<a name="l00111"></a>00111
<a name="l00115"></a>00115 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#abf9e6ebb56a51c53d0366cecdf3bd654">DoCancel</a>();
<a name="l00116"></a>00116
<a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#a96613975c015dea937d1958227df5bd7">RunL</a>();
<a name="l00121"></a>00121
<a name="l00125"></a>00125 TInt <a class="code" href="class_c_task_manager_engine.html#a49ee6807db2a18eadfa2c344d19d7f7c">RunError</a>( TInt aError );
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">public</span>: <span class="comment">// Main interface for engine logic</span>
<a name="l00128"></a>00128
<a name="l00136"></a>00136 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#ac16a8d2c10448eb7d6a8ce7997cee2fe">SetConnectionSettings</a>(<span class="keyword">const</span> TDesC& aServerName,
<a name="l00137"></a>00137 <span class="keyword">const</span> TInt& aPort,
<a name="l00138"></a>00138 <span class="keyword">const</span> TDesC& aUsername,
<a name="l00139"></a>00139 <span class="keyword">const</span> TDesC& aPassword);
<a name="l00140"></a>00140
<a name="l00145"></a>00145 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#af8dff876e1096bfdc3bb69b56e35454d">FetchTasksL</a>();
<a name="l00146"></a>00146
<a name="l00151"></a>00151 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#aa8b954c7dfd4859d7a6bbf82174e9d48">MarkTaskDoneL</a>(<span class="keyword">const</span> TInt& aTaskId);
<a name="l00152"></a>00152
<a name="l00156"></a>00156 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#a225fa09d24a862f63f0b3c48192c0962">CheckRefreshL</a>();
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">public</span>: <span class="comment">// from MEngineNotifier</span>
<a name="l00159"></a>00159
<a name="l00164"></a>00164 TBool <a class="code" href="class_c_task_manager_engine.html#a0878a2c467b0e65c391b58952cbba01f">PackageReceivedL</a>( <span class="keyword">const</span> TDesC8& aData );
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="keyword">public</span>: <span class="comment">// MTimeoutNotifier</span>
<a name="l00167"></a>00167
<a name="l00171"></a>00171 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#ace09b9aeb7c9dc50dd769e5d0cc489e7">TimerExpired</a>();
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">public</span>: <span class="comment">// New functions</span>
<a name="l00174"></a>00174
<a name="l00179"></a>00179 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#a8fad65e8b184faab096d087eead56fc8">SetIap</a>(<span class="keyword">const</span> TUint32& aId);
<a name="l00180"></a>00180
<a name="l00184"></a>00184 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#a5b4851d22df114957e74c7f05c31b365">CancelTransaction</a>();
<a name="l00185"></a>00185
<a name="l00190"></a>00190 TBool <a class="code" href="class_c_task_manager_engine.html#a94c8f7a09b54224b0cbd090eb06e7690">IapSet</a>() <span class="keyword">const</span>;
<a name="l00191"></a>00191
<a name="l00196"></a>00196 RArray<TIap>& <a class="code" href="class_c_task_manager_engine.html#a59c17c9d84ecb72ecc26ebb79195698d">Iaps</a>();
<a name="l00197"></a>00197
<a name="l00203"></a>00203 <span class="keywordtype">void</span> <a class="code" href="class_c_task_manager_engine.html#a6cb8519da9c054c68d00be39a5155a97">SetAutomaticUpdateL</a>(<span class="keyword">const</span> TBool& aOn);
<a name="l00204"></a>00204
<a name="l00205"></a>00205 <span class="keyword">private</span>: <span class="comment">// Functions from base classes</span>
<a name="l00206"></a>00206
<a name="l00210"></a>00210 <span class="keywordtype">void</span> HandleSessionEventL(TMsvSessionEvent aEvent, TAny* aArg1, TAny* aArg2, TAny* aArg3);
<a name="l00211"></a>00211
<a name="l00212"></a>00212 <span class="keyword">private</span>: <span class="comment">// New functions</span>
<a name="l00213"></a>00213
<a name="l00217"></a>00217 <span class="keywordtype">void</span> LoadIapsL();
<a name="l00218"></a>00218
<a name="l00222"></a>00222 <span class="keywordtype">void</span> ConnectL();
<a name="l00223"></a>00223
<a name="l00228"></a>00228 <span class="keywordtype">void</span> ConnectL( TUint32 aAddr );
<a name="l00229"></a>00229
<a name="l00235"></a>00235 TBool CheckAndReportErrorsL();
<a name="l00236"></a>00236
<a name="l00240"></a>00240 <span class="keywordtype">void</span> GPRSConnectL();
<a name="l00241"></a>00241
<a name="l00245"></a>00245 <span class="keywordtype">void</span> EndConnection();
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="keyword">private</span>:
<a name="l00248"></a>00248
<a name="l00252"></a>00252 <a class="code" href="class_c_task_manager_engine.html">CTaskManagerEngine</a>(<a class="code" href="class_m_transaction_observer.html">MTransactionObserver</a>& aObserver);
<a name="l00253"></a>00253 <span class="keywordtype">void</span> ConstructL();
<a name="l00254"></a>00254
<a name="l00255"></a>00255 <span class="keyword">enum</span> TEngineState
<a name="l00256"></a>00256 {
<a name="l00257"></a>00257 <span class="comment">// Connection enums</span>
<a name="l00258"></a>00258 ENotConnected = 1,
<a name="l00259"></a>00259 EStartingGPRS,
<a name="l00260"></a>00260 ELookingUp,
<a name="l00261"></a>00261 EConnecting,
<a name="l00262"></a>00262 ESSLConnecting,
<a name="l00263"></a>00263 EConnected,
<a name="l00264"></a>00264
<a name="l00265"></a>00265 <span class="comment">// Transmission enums</span>
<a name="l00266"></a>00266 EWriting,
<a name="l00267"></a>00267 EReading
<a name="l00268"></a>00268 };
<a name="l00269"></a>00269
<a name="l00270"></a>00270 <span class="keyword">private</span>: <span class="comment">// Data members</span>
<a name="l00271"></a>00271
<a name="l00272"></a>00272 <span class="comment">// Timeout-constant, defined in .cpp</span>
<a name="l00273"></a>00273 <span class="keyword">static</span> <span class="keyword">const</span> TInt KTimeOut;
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="comment">// Socket handles and variables</span>
<a name="l00276"></a>00276 RSocketServ iSocketServer;
<a name="l00277"></a>00277 RSocket iSocket;
<a name="l00278"></a>00278 RConnection iConnection;
<a name="l00279"></a>00279 CSecureSocket* iSecureSocket;
<a name="l00280"></a>00280 TInetAddr iAddress;
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="comment">// State of engine</span>
<a name="l00283"></a>00283 TEngineState iState;
<a name="l00284"></a>00284
<a name="l00285"></a>00285 <span class="comment">// Timeout timer</span>
<a name="l00286"></a>00286 <a class="code" href="class_c_time_out_timer.html">CTimeOutTimer</a>* iTimer;
<a name="l00287"></a>00287
<a name="l00288"></a>00288 <span class="comment">// Which operation is being performed</span>
<a name="l00289"></a>00289 <a class="code" href="class_t_request.html#aa84aea38f54090a2fc4755441ea99086">TRequest::TOperationType</a> iOperation;
<a name="l00290"></a>00290
<a name="l00291"></a>00291 <span class="comment">// If the operation is "mark task", the id of</span>
<a name="l00292"></a>00292 <span class="comment">// the task is stored here.</span>
<a name="l00293"></a>00293 TBuf<5> iMarkId;
<a name="l00294"></a>00294
<a name="l00295"></a>00295 <span class="comment">// DNS resolver</span>
<a name="l00296"></a>00296 RHostResolver iResolver;
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="comment">// Result from DNS resolver</span>
<a name="l00299"></a>00299 TNameEntry iNameEntry;
<a name="l00300"></a>00300 TNameRecord iNameRecord;
<a name="l00301"></a>00301
<a name="l00302"></a>00302 <span class="comment">// Message server observation</span>
<a name="l00303"></a>00303 CMsvSession* iMsvSession;
<a name="l00304"></a>00304 CMsvEntry* iMsvEntry;
<a name="l00305"></a>00305
<a name="l00306"></a>00306 <span class="comment">// Handle to inform view</span>
<a name="l00307"></a>00307 <a class="code" href="class_m_transaction_observer.html">MTransactionObserver</a>& iTransactionObserver;
<a name="l00308"></a>00308
<a name="l00309"></a>00309 <span class="comment">// User variables</span>
<a name="l00310"></a>00310 TBuf<KMaxUsernameLength> iUsername;
<a name="l00311"></a>00311 TBuf<KMaxPasswordLength> iPassword;
<a name="l00312"></a>00312 TBuf<KMaxServerNameLength> iServer;
<a name="l00313"></a>00313 TInt iPort;
<a name="l00314"></a>00314
<a name="l00315"></a>00315 <span class="comment">// Write message buffer</span>
<a name="l00316"></a>00316 TBuf8<KMaxWriteBufferSize> iWriteBuffer;
<a name="l00317"></a>00317
<a name="l00318"></a>00318 <span class="comment">// Active object for reading inbound streams</span>
<a name="l00319"></a>00319 <a class="code" href="class_c_task_manager_engine_reader.html">CTaskManagerEngineReader</a>* iReader;
<a name="l00320"></a>00320
<a name="l00321"></a>00321 <span class="comment">// Parser class, hides the structure of messages from the engine</span>
<a name="l00322"></a>00322 <a class="code" href="class_c_response.html">CResponse</a>* iResponse;
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="comment">// The amount of data read is stored here</span>
<a name="l00325"></a>00325 TSockXfrLength iDummyLength;
<a name="l00326"></a>00326
<a name="l00327"></a>00327 TBool iRunning;
<a name="l00328"></a>00328 TBool iDoRefresh;
<a name="l00329"></a>00329 TBool iOpeningConnection;
<a name="l00330"></a>00330 RArray<TIap> iIAPs;
<a name="l00331"></a>00331 TUint32 iIap;
<a name="l00332"></a>00332 TBool iAutomaticUpdate;
<a name="l00333"></a>00333 };
<a name="l00334"></a>00334
<a name="l00335"></a>00335 <span class="preprocessor">#endif</span>
<a name="l00336"></a>00336 <span class="preprocessor"></span>
<a name="l00337"></a>00337 <span class="comment">// End of file</span>
<a name="l00338"></a>00338
<a name="l00339"></a>00339
<a name="l00340"></a>00340
</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>