Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_task_manager_engine.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: CTaskManagerEngine Class Reference</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 -->
<div class="contents">
<h1>CTaskManagerEngine Class Reference</h1><!-- doxytag: class="CTaskManagerEngine" --><!-- doxytag: inherits="MEngineNotifier,MTimeoutNotifier" -->
<p>Inherits <a class="el" href="class_m_engine_notifier.html">MEngineNotifier</a>, and <a class="el" href="class_m_timeout_notifier.html">MTimeoutNotifier</a>.</p>
<p><a href="class_c_task_manager_engine-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a266a60f9e39fc2c976c2b26c23550190">~CTaskManagerEngine</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#ac16a8d2c10448eb7d6a8ce7997cee2fe">SetConnectionSettings</a> (const TDesC &aServerName, const TInt &aPort, const TDesC &aUsername, const TDesC &aPassword)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#af8dff876e1096bfdc3bb69b56e35454d">FetchTasksL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#aa8b954c7dfd4859d7a6bbf82174e9d48">MarkTaskDoneL</a> (const TInt &aTaskId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a225fa09d24a862f63f0b3c48192c0962">CheckRefreshL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a0878a2c467b0e65c391b58952cbba01f">PackageReceivedL</a> (const TDesC8 &aData)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#ace09b9aeb7c9dc50dd769e5d0cc489e7">TimerExpired</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a8fad65e8b184faab096d087eead56fc8">SetIap</a> (const TUint32 &aId)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a5b4851d22df114957e74c7f05c31b365">CancelTransaction</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a94c8f7a09b54224b0cbd090eb06e7690">IapSet</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RArray< <a class="el" href="class_t_iap.html">TIap</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a59c17c9d84ecb72ecc26ebb79195698d">Iaps</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a6cb8519da9c054c68d00be39a5155a97">SetAutomaticUpdateL</a> (const TBool &aOn)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_task_manager_engine.html">CTaskManagerEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a048ea3e52e18a4c300d4d79d1dc2c247">NewL</a> (<a class="el" href="class_m_transaction_observer.html">MTransactionObserver</a> &aObserver)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#abf9e6ebb56a51c53d0366cecdf3bd654">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a96613975c015dea937d1958227df5bd7">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_task_manager_engine.html#a49ee6807db2a18eadfa2c344d19d7f7c">RunError</a> (TInt aError)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An engine class. Used for communicating with the server. Listens also for incoming SMS messages. </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8h_source.html#l00093">93</a> of file <a class="el" href="_task_manager_engine_8h_source.html">TaskManagerEngine.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a266a60f9e39fc2c976c2b26c23550190"></a><!-- doxytag: member="CTaskManagerEngine::~CTaskManagerEngine" ref="a266a60f9e39fc2c976c2b26c23550190" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTaskManagerEngine::~CTaskManagerEngine </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00063">63</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a048ea3e52e18a4c300d4d79d1dc2c247"></a><!-- doxytag: member="CTaskManagerEngine::NewL" ref="a048ea3e52e18a4c300d4d79d1dc2c247" args="(MTransactionObserver &aObserver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_task_manager_engine.html">CTaskManagerEngine</a> * CTaskManagerEngine::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_transaction_observer.html">MTransactionObserver</a> & </td>
<td class="paramname"> <em>aObserver</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Two-phased constructor. </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00089">89</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abf9e6ebb56a51c53d0366cecdf3bd654"></a><!-- doxytag: member="CTaskManagerEngine::DoCancel" ref="abf9e6ebb56a51c53d0366cecdf3bd654" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel any outstanding operation </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00470">470</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a96613975c015dea937d1958227df5bd7"></a><!-- doxytag: member="CTaskManagerEngine::RunL" ref="a96613975c015dea937d1958227df5bd7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when an operation completes </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00524">524</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a49ee6807db2a18eadfa2c344d19d7f7c"></a><!-- doxytag: member="CTaskManagerEngine::RunError" ref="a49ee6807db2a18eadfa2c344d19d7f7c" args="(TInt aError)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CTaskManagerEngine::RunError </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aError</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles a leave occurring in the request completion event handler <a class="el" href="class_c_task_manager_engine.html#a96613975c015dea937d1958227df5bd7">RunL()</a> </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00657">657</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac16a8d2c10448eb7d6a8ce7997cee2fe"></a><!-- doxytag: member="CTaskManagerEngine::SetConnectionSettings" ref="ac16a8d2c10448eb7d6a8ce7997cee2fe" args="(const TDesC &aServerName, const TInt &aPort, const TDesC &aUsername, const TDesC &aPassword)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::SetConnectionSettings </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aServerName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TInt & </td>
<td class="paramname"> <em>aPort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aUsername</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aPassword</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the connections settings. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aServerName</em> </td><td>name of the server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aPort</em> </td><td>Port number of the server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aUsername</em> </td><td>Username. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aPassword</em> </td><td>Password. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00132">132</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af8dff876e1096bfdc3bb69b56e35454d"></a><!-- doxytag: member="CTaskManagerEngine::FetchTasksL" ref="af8dff876e1096bfdc3bb69b56e35454d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::FetchTasksL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Will make a socket call to the server. As a result, we will get all tasks of the user. </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00199">199</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa8b954c7dfd4859d7a6bbf82174e9d48"></a><!-- doxytag: member="CTaskManagerEngine::MarkTaskDoneL" ref="aa8b954c7dfd4859d7a6bbf82174e9d48" args="(const TInt &aTaskId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::MarkTaskDoneL </td>
<td>(</td>
<td class="paramtype">const TInt & </td>
<td class="paramname"> <em>aTaskId</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Will make a socket call to the server that is used for completing a wanted task. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTaskId</em> </td><td>The id of the task that is to be completed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00215">215</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a225fa09d24a862f63f0b3c48192c0962"></a><!-- doxytag: member="CTaskManagerEngine::CheckRefreshL" ref="a225fa09d24a862f63f0b3c48192c0962" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::CheckRefreshL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if tasks needs to be reloaded. If so, starts the downloading process. </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00251">251</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0878a2c467b0e65c391b58952cbba01f"></a><!-- doxytag: member="CTaskManagerEngine::PackageReceivedL" ref="a0878a2c467b0e65c391b58952cbba01f" args="(const TDesC8 &aData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CTaskManagerEngine::PackageReceivedL </td>
<td>(</td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aData</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Socket reader notifies the engine of a new package through this function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aData</em> </td><td>The package received. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_m_engine_notifier.html">MEngineNotifier</a>.</p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00721">721</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ace09b9aeb7c9dc50dd769e5d0cc489e7"></a><!-- doxytag: member="CTaskManagerEngine::TimerExpired" ref="ace09b9aeb7c9dc50dd769e5d0cc489e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::TimerExpired </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called by the timer whenever a timeout occurs. </p>
<p>Implements <a class="el" href="class_m_timeout_notifier.html">MTimeoutNotifier</a>.</p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00787">787</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8fad65e8b184faab096d087eead56fc8"></a><!-- doxytag: member="CTaskManagerEngine::SetIap" ref="a8fad65e8b184faab096d087eead56fc8" args="(const TUint32 &aId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::SetIap </td>
<td>(</td>
<td class="paramtype">const TUint32 & </td>
<td class="paramname"> <em>aId</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>With this function you can select which IAP is used for the connection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aId</em> </td><td>id of the IAP to be used. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00148">148</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5b4851d22df114957e74c7f05c31b365"></a><!-- doxytag: member="CTaskManagerEngine::CancelTransaction" ref="a5b4851d22df114957e74c7f05c31b365" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::CancelTransaction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is used for cancelling a socket transaction. </p>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00230">230</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a94c8f7a09b54224b0cbd090eb06e7690"></a><!-- doxytag: member="CTaskManagerEngine::IapSet" ref="a94c8f7a09b54224b0cbd090eb06e7690" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CTaskManagerEngine::IapSet </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether IAP has been set or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ETrue if IAP is set, EFalse if not. </dd></dl>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00158">158</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a59c17c9d84ecb72ecc26ebb79195698d"></a><!-- doxytag: member="CTaskManagerEngine::Iaps" ref="a59c17c9d84ecb72ecc26ebb79195698d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RArray< <a class="el" href="class_t_iap.html">TIap</a> > & CTaskManagerEngine::Iaps </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns all found IAPs. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to an array of IAPs. </dd></dl>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00390">390</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6cb8519da9c054c68d00be39a5155a97"></a><!-- doxytag: member="CTaskManagerEngine::SetAutomaticUpdateL" ref="a6cb8519da9c054c68d00be39a5155a97" args="(const TBool &aOn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTaskManagerEngine::SetAutomaticUpdateL </td>
<td>(</td>
<td class="paramtype">const TBool & </td>
<td class="paramname"> <em>aOn</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function sets the automatic task loading on or off. If this functionality is set on, tasks are loaded automatically when an update SMS message is received. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aOn</em> </td><td>ETrue if tasks are loaded automatically, EFalse if not. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_task_manager_engine_8cpp_source.html#l00271">271</a> of file <a class="el" href="_task_manager_engine_8cpp_source.html">TaskManagerEngine.cpp</a>.</p>
</div>
</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>