Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/consumer_8cpp_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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/Base/IPC/condvar/condvarlocal/src/consumer.cpp 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/Base/IPC/condvar/condvarlocal/src/consumer.cpp</h1><a href="consumer_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of &quot;Eclipse Public License v1.0&quot;</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">// Contains the definition of member functions of the CConsumer class.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 
<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;<a class="code" href="consumer_8h.html">consumer.h</a>&quot;</span>
<a name="l00024"></a>00024 
<a name="l00031"></a><a class="code" href="class_c_consumer.html#a7ba476d5a42cbd16448b540867bd141b">00031</a> <a class="code" href="class_c_consumer.html">CConsumer</a>* <a class="code" href="class_c_consumer.html#a7ba476d5a42cbd16448b540867bd141b">CConsumer::NewL</a>(CConsoleBase* aConsole,<a class="code" href="class_c_queue.html">CQueue</a>* aTokens)
<a name="l00032"></a>00032         {
<a name="l00033"></a>00033         <a class="code" href="class_c_consumer.html">CConsumer</a>* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave)<a class="code" href="class_c_consumer.html">CConsumer</a>;
<a name="l00034"></a>00034         CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00035"></a>00035         <span class="keyword">self</span>-&gt;ConstructL(aConsole,aTokens);
<a name="l00036"></a>00036         CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00037"></a>00037         <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00038"></a>00038         }
<a name="l00039"></a>00039 
<a name="l00051"></a><a class="code" href="class_c_consumer.html#ae769aaadb4500557f88dfe64755a4db5">00051</a> <span class="keywordtype">void</span> <a class="code" href="class_c_consumer.html#ae769aaadb4500557f88dfe64755a4db5">CConsumer::ConstructL</a>(CConsoleBase* aConsole,<a class="code" href="class_c_queue.html">CQueue</a>* aTokens)
<a name="l00052"></a>00052         {
<a name="l00053"></a>00053         iConsole = aConsole;
<a name="l00054"></a>00054         iQueue = aTokens;
<a name="l00055"></a>00055 
<a name="l00056"></a>00056         <span class="comment">// Create an object of the CPeriodic class.</span>
<a name="l00057"></a>00057         iPeriodicCons = <a class="code" href="class_c_consumer.html#a7ba476d5a42cbd16448b540867bd141b">CPeriodic::NewL</a>(CActive::EPriorityUserInput);
<a name="l00058"></a>00058 
<a name="l00059"></a>00059         <span class="comment">// Create the Consumer thread.</span>
<a name="l00060"></a>00060         <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KConsumer,<span class="stringliteral">&quot;ConsumerThread&quot;</span>);
<a name="l00061"></a>00061         User::LeaveIfError(iConsThread.Create(KConsumer,<a class="code" href="class_c_consumer.html#a986aa37709261200c981221e8d6c093e">ConsThreadFunc</a>,KDefaultStackSize,KMinHeapSize,256*KMinHeapSize,iQueue,EOwnerThread));
<a name="l00062"></a>00062         iConsThread.SetPriority(EPriorityMore);
<a name="l00063"></a>00063 
<a name="l00064"></a>00064         <span class="comment">// Make the Consumer thread more intensive than the Producer thread.</span>
<a name="l00065"></a>00065         <span class="comment">// Consumer thread frequency is twice the Producer thread frequency.</span>
<a name="l00066"></a>00066         <span class="comment">// Associate RemoveFunction() as the call back function for the iPeriodicCons object.</span>
<a name="l00067"></a>00067         iPeriodicCons-&gt;Start(2000000,2000000,TCallBack(<a class="code" href="class_c_consumer.html#aee1ff1fbf228d676e06aa5bd7c1d9799">RemoveFunction</a>,<span class="keyword">this</span>));
<a name="l00068"></a>00068         }
<a name="l00069"></a>00069 
<a name="l00073"></a>00073 CConsumer::CConsumer()
<a name="l00074"></a>00074         {
<a name="l00075"></a>00075         }
<a name="l00076"></a>00076 
<a name="l00082"></a><a class="code" href="class_c_consumer.html#a986aa37709261200c981221e8d6c093e">00082</a> TInt <a class="code" href="class_c_consumer.html#a986aa37709261200c981221e8d6c093e">CConsumer::ConsThreadFunc</a>(TAny* aPtr)
<a name="l00083"></a>00083         {
<a name="l00084"></a>00084         <span class="comment">// The while loop mechanism ensures that the thread performs the CQueue::Remove() operation each time RThread::Resume() is invoked on the thread handle.</span>
<a name="l00085"></a>00085         <span class="keywordflow">while</span>(<span class="keyword">true</span>)
<a name="l00086"></a>00086                 {
<a name="l00087"></a>00087                 <a class="code" href="class_c_queue.html">CQueue</a>* ptr = (<a class="code" href="class_c_queue.html">CQueue</a>*)aPtr;
<a name="l00088"></a>00088                 __ASSERT_ALWAYS(ptr,User::Panic(KTxtPanic,-1));
<a name="l00089"></a>00089                 <span class="comment">// Remove a token from the queue.</span>
<a name="l00090"></a>00090                 ptr-&gt;<a class="code" href="class_c_queue.html#ab95dcac0beafcc90e1d2cdad2edfb35d">Remove</a>();
<a name="l00091"></a>00091                 <span class="comment">// Suspend the thread.</span>
<a name="l00092"></a>00092                 RThread().Suspend();
<a name="l00093"></a>00093                 }
<a name="l00094"></a>00094         <span class="keywordflow">return</span> KErrNone;
<a name="l00095"></a>00095         }
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 
<a name="l00101"></a><a class="code" href="class_c_consumer.html#a7c2ffe71d0d3f918b183152bd285b417">00101</a> <span class="keywordtype">void</span> <a class="code" href="class_c_consumer.html#a7c2ffe71d0d3f918b183152bd285b417">CConsumer::ResumeCons</a>()
<a name="l00102"></a>00102         {
<a name="l00103"></a>00103         <span class="comment">// Call the RThread::Resume() function on the consumer thread.</span>
<a name="l00104"></a>00104         <span class="comment">// Control goes to the CConsumer::ConsThreadFunc() function after this statement.</span>
<a name="l00105"></a>00105         iConsThread.Resume();
<a name="l00106"></a>00106         }
<a name="l00107"></a>00107 
<a name="l00111"></a><a class="code" href="class_c_consumer.html#a19534e537b8036dac44e58a460ce7a01">00111</a> <a class="code" href="class_c_consumer.html#a19534e537b8036dac44e58a460ce7a01">CConsumer::~CConsumer</a>()
<a name="l00112"></a>00112         {
<a name="l00113"></a>00113         iConsThread.Kill(KErrCancel);
<a name="l00114"></a>00114         <span class="keyword">delete</span> iPeriodicCons;
<a name="l00115"></a>00115         }
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 
<a name="l00123"></a><a class="code" href="class_c_consumer.html#aee1ff1fbf228d676e06aa5bd7c1d9799">00123</a> TInt <a class="code" href="class_c_consumer.html#aee1ff1fbf228d676e06aa5bd7c1d9799">CConsumer::RemoveFunction</a>(TAny* aPtr)
<a name="l00124"></a>00124         {
<a name="l00125"></a>00125         <a class="code" href="class_c_consumer.html">CConsumer</a>* ptr = <span class="keyword">static_cast&lt;</span><a class="code" href="class_c_consumer.html">CConsumer</a>*<span class="keyword">&gt;</span> (aPtr);
<a name="l00126"></a>00126         __ASSERT_ALWAYS(ptr,User::Panic(KTxtPanic,-1));
<a name="l00127"></a>00127         <span class="comment">// Invoke the RThread::Resume() function on the consumer thread repeatedly.</span>
<a name="l00128"></a>00128         ptr-&gt;<a class="code" href="class_c_consumer.html#a7c2ffe71d0d3f918b183152bd285b417">ResumeCons</a>();
<a name="l00129"></a>00129         <span class="keywordflow">return</span> KErrNone;
<a name="l00130"></a>00130         }
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>