Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_thread_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: CThreadEngine 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>CThreadEngine Class Reference</h1><!-- doxytag: class="CThreadEngine" -->
<p><a href="class_c_thread_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_thread_engine.html#a78c4edde0ad6368f8901dd20170ac889">~CThreadEngine</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#a48334d697168092a5e7be817e45fd176">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_thread_engine.html#aec36044be34b754c06dc98a9c2836fdb">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_thread_engine.html#a7768311c64d094ac44485243026b6e46">RunError</a> (TInt aError)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#a0bfcabc0c045354d389f61d355ca0490">StartL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#ad53a8e971af48dd561844863a5ff3888">CreateThreadsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#a222c982a5bc397dfa3fd17ea37ce4dda">KillThread</a> (TInt aThreadCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#af3982a90e967a486bde825f5aa2ddc55">SetSyncValue</a> (TInt aValue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#a7f6b1665b605dcf900473bce9a9191b9">GetSyncValue</a> () const </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_thread_engine.html">CThreadEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#af36e9899e337766ff0bd7ee9c5080f60">NewL</a> (<a class="el" href="class_c_thread_app_view.html">CThreadAppView</a> *aView)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_thread_engine.html">CThreadEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#a311d84662a41a7a2221b8d049eb3d525">NewLC</a> (<a class="el" href="class_c_thread_app_view.html">CThreadAppView</a> *aView)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#ab8dd5de1ec65da63b17fc87dd402f07b">ExecuteThreadOne</a> (TAny *aPtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#ad2122547b95714aa7dea18f28e77ca14">ExecuteThreadTwo</a> (TAny *aPtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_thread_engine.html#a12d8af3f0da569111fe99ebb4101f7b4">ExecuteThreadThree</a> (TAny *aPtr)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab904aa44139219b15fd735aa05a2cb6e"></a><!-- doxytag: member="CThreadEngine::iMutex" ref="ab904aa44139219b15fd735aa05a2cb6e" args="" -->
RMutex </td><td class="memItemRight" valign="bottom"><b>iMutex</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_thread_engine.html">CThreadEngine</a> application engine class. </p>
<p>Definition at line <a class="el" href="threadengine_8h_source.html#l00026">26</a> of file <a class="el" href="threadengine_8h_source.html">threadengine.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a78c4edde0ad6368f8901dd20170ac889"></a><!-- doxytag: member="CThreadEngine::~CThreadEngine" ref="a78c4edde0ad6368f8901dd20170ac889" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CThreadEngine::~CThreadEngine </td>
<td>(</td>
<td class="paramtype">void </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="threadengine_8cpp_source.html#l00042">42</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af36e9899e337766ff0bd7ee9c5080f60"></a><!-- doxytag: member="CThreadEngine::NewL" ref="af36e9899e337766ff0bd7ee9c5080f60" args="(CThreadAppView *aView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_thread_engine.html">CThreadEngine</a> * CThreadEngine::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_thread_app_view.html">CThreadAppView</a> * </td>
<td class="paramname"> <em>aView</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#af36e9899e337766ff0bd7ee9c5080f60">NewL()</a></p>
<p>Create new <a class="el" href="class_c_thread_engine.html">CThreadEngine</a> object return a pointer to the created instance of <a class="el" href="class_c_thread_engine.html">CThreadEngine</a> </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aView</em> </td><td>a Pointer to <a class="el" href="class_c_thread_app_view.html">CThreadAppView</a>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00056">56</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a311d84662a41a7a2221b8d049eb3d525"></a><!-- doxytag: member="CThreadEngine::NewLC" ref="a311d84662a41a7a2221b8d049eb3d525" args="(CThreadAppView *aView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_thread_engine.html">CThreadEngine</a> * CThreadEngine::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_thread_app_view.html">CThreadAppView</a> * </td>
<td class="paramname"> <em>aView</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#a311d84662a41a7a2221b8d049eb3d525">NewLC()</a> </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00063">63</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a48334d697168092a5e7be817e45fd176"></a><!-- doxytag: member="CThreadEngine::DoCancel" ref="a48334d697168092a5e7be817e45fd176" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CThreadEngine::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>DoCancelL()</p>
<p>Cancels the timer. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00197">197</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aec36044be34b754c06dc98a9c2836fdb"></a><!-- doxytag: member="CThreadEngine::RunL" ref="aec36044be34b754c06dc98a9c2836fdb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CThreadEngine::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#aec36044be34b754c06dc98a9c2836fdb">RunL()</a></p>
<p>Implementation of the timer's virtual method. Check that all threads are alive and running, if not then restart them. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00103">103</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7768311c64d094ac44485243026b6e46"></a><!-- doxytag: member="CThreadEngine::RunError" ref="a7768311c64d094ac44485243026b6e46" args="(TInt aError)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CThreadEngine::RunError </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aError</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#a7768311c64d094ac44485243026b6e46">RunError()</a></p>
<p>Handles a leave occurring in the request completion event handler <a class="el" href="class_c_thread_engine.html#aec36044be34b754c06dc98a9c2836fdb">RunL()</a>. return returns always KErrNone </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00207">207</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0bfcabc0c045354d389f61d355ca0490"></a><!-- doxytag: member="CThreadEngine::StartL" ref="a0bfcabc0c045354d389f61d355ca0490" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CThreadEngine::StartL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#a0bfcabc0c045354d389f61d355ca0490">StartL()</a></p>
<p>CreateThreads and start the timer after delay. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00085">85</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad53a8e971af48dd561844863a5ff3888"></a><!-- doxytag: member="CThreadEngine::CreateThreadsL" ref="ad53a8e971af48dd561844863a5ff3888" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CThreadEngine::CreateThreadsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#ad53a8e971af48dd561844863a5ff3888">CreateThreadsL()</a></p>
<p>Initialize 3 threads and start them. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00386">386</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab8dd5de1ec65da63b17fc87dd402f07b"></a><!-- doxytag: member="CThreadEngine::ExecuteThreadOne" ref="ab8dd5de1ec65da63b17fc87dd402f07b" args="(TAny *aPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CThreadEngine::ExecuteThreadOne </td>
<td>(</td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aPtr</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#ab8dd5de1ec65da63b17fc87dd402f07b">ExecuteThreadOne()</a>;</p>
<p>Function for thread one. Thread one executes this function while it's running. param aPtr pointer to a resource. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00293">293</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad2122547b95714aa7dea18f28e77ca14"></a><!-- doxytag: member="CThreadEngine::ExecuteThreadTwo" ref="ad2122547b95714aa7dea18f28e77ca14" args="(TAny *aPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CThreadEngine::ExecuteThreadTwo </td>
<td>(</td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aPtr</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#ad2122547b95714aa7dea18f28e77ca14">ExecuteThreadTwo()</a></p>
<p>Function for thread two. Thread two executes this function while it's running. param aPtr pointer to a resource. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00316">316</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a12d8af3f0da569111fe99ebb4101f7b4"></a><!-- doxytag: member="CThreadEngine::ExecuteThreadThree" ref="a12d8af3f0da569111fe99ebb4101f7b4" args="(TAny *aPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CThreadEngine::ExecuteThreadThree </td>
<td>(</td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aPtr</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#a12d8af3f0da569111fe99ebb4101f7b4">ExecuteThreadThree()</a></p>
<p>Function for thread three. Thread three executes this function while it's running. param aPtr pointer to a resource. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00339">339</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a222c982a5bc397dfa3fd17ea37ce4dda"></a><!-- doxytag: member="CThreadEngine::KillThread" ref="a222c982a5bc397dfa3fd17ea37ce4dda" args="(TInt aThreadCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CThreadEngine::KillThread </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aThreadCount</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#a222c982a5bc397dfa3fd17ea37ce4dda">KillThread()</a></p>
<p>Kill one of the threads. CreateThreadsL must have been called before this. param aThreadCount the number of the thread that should be killed (1-3). </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00235">235</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af3982a90e967a486bde825f5aa2ddc55"></a><!-- doxytag: member="CThreadEngine::SetSyncValue" ref="af3982a90e967a486bde825f5aa2ddc55" args="(TInt aValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CThreadEngine::SetSyncValue </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aValue</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#af3982a90e967a486bde825f5aa2ddc55">SetSyncValue()</a></p>
<p>This is a thread-safe function. Set synchronized variable. param aValue Value of the variable. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00362">362</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f6b1665b605dcf900473bce9a9191b9"></a><!-- doxytag: member="CThreadEngine::GetSyncValue" ref="a7f6b1665b605dcf900473bce9a9191b9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CThreadEngine::GetSyncValue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_thread_engine.html#a7f6b1665b605dcf900473bce9a9191b9">GetSyncValue()</a></p>
<p>This is a thread-safe function. return value of the synchronized variable. </p>
<p>Definition at line <a class="el" href="threadengine_8cpp_source.html#l00375">375</a> of file <a class="el" href="threadengine_8cpp_source.html">threadengine.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>