Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/condvarlocal_8cpp-source.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Tue, 30 Mar 2010 11:42:04 +0100
changeset 4 4816d766a08a
parent 1 25a17d01db0c
permissions -rw-r--r--
Week 12 contribution of SDK documentation_content. See release notes for details. Fixes Bug 1892, Bug 1522, Bug 1520, Bug 394, Bug 1319, Bug 344, Bug 1897

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/Base/IPC/condvar/condvarlocal/src/condvarlocal.cpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/Base/IPC/condvar/condvarlocal/src/condvarlocal.cpp</h1><a href="condvarlocal_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 "Eclipse Public License v1.0"</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 "http://www.eclipse.org/legal/epl-v10.html".</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 E32Main() function, which executes the example.</span>
<a name="l00015"></a>00015 <span class="comment">// The example demonstrates the use of local condition variable IPC mechanism. The threads created in the process use this condition variable to co-operate with each other.</span>
<a name="l00016"></a>00016 <span class="comment">// The example performs the following tasks:</span>
<a name="l00017"></a>00017 <span class="comment">// - create an object of the CQueue class, which in turn crates a queue of integer tokens</span>
<a name="l00018"></a>00018 <span class="comment">// - create an object of the CProducer class, which in turn creates the producer thread</span>
<a name="l00019"></a>00019 <span class="comment">// - create an object of the CConsumer class, which in turn creates the consumer thread</span>
<a name="l00020"></a>00020 <span class="comment">// - create an object of the CUserInterface class ,which accepts asynchronous key press events from the console.</span>
<a name="l00021"></a>00021 <span class="comment">// The CUserInterface class provides an interface for the user to interact with the threads created in the example.</span>
<a name="l00022"></a>00022 <span class="comment">// The CQueue::iCondVar is the local condition varaibale that is used by the two threads to co-operate with each other.</span>
<a name="l00023"></a>00023 <span class="comment">//</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="globals_8h.html">globals.h</a>"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="queue_8h.html">queue.h</a>"</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="producer_8h.html">producer.h</a>"</span>
<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="consumer_8h.html">consumer.h</a>"</span>
<a name="l00039"></a>00039 <span class="preprocessor">#include "<a class="code" href="_i_p_c_2condvar_2condvarlocal_2inc_2userinterface_8h.html">userinterface.h</a>"</span>
<a name="l00040"></a>00040 
<a name="l00041"></a><a class="code" href="condvarlocal_8cpp.html#d789d40251baeb2f60e118de4856583d">00041</a> LOCAL_D CConsoleBase* <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>;
<a name="l00042"></a>00042 LOCAL_C <span class="keywordtype">void</span> <a class="code" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp.html#feaed5465c78704271678cde943d7e8a">DoExampleL</a>();
<a name="l00043"></a>00043 LOCAL_C <span class="keywordtype">void</span> callExampleL();
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 LOCAL_C <span class="keywordtype">void</span> <a class="code" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp.html#feaed5465c78704271678cde943d7e8a">DoExampleL</a>()
<a name="l00046"></a>00046         {
<a name="l00047"></a>00047         CActiveScheduler* scheduler = <span class="keyword">new</span> (ELeave) CActiveScheduler();
<a name="l00048"></a>00048         CleanupStack::PushL(scheduler);
<a name="l00049"></a>00049         CActiveScheduler::Install(scheduler);
<a name="l00050"></a>00050 
<a name="l00051"></a>00051         <span class="comment">// Create an object of the CQueue class.</span>
<a name="l00052"></a>00052         <a class="code" href="class_c_queue.html">CQueue</a>* tokens = <a class="code" href="class_c_queue.html#2c3c0bae6b0e6aaa10df8fb51dfb7e30">CQueue::NewL</a>();
<a name="l00053"></a>00053         CleanupStack::PushL(tokens);
<a name="l00054"></a>00054 
<a name="l00055"></a>00055         <span class="comment">// Print the KTextInvokeProducer string and wait for a key press.</span>
<a name="l00056"></a>00056         _LIT(KTextInvokeProducer,<span class="stringliteral">"Creating and starting the Producer Thread...[This produces a token every two seconds]\n"</span>);
<a name="l00057"></a>00057         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTextInvokeProducer);
<a name="l00058"></a>00058         _LIT(KTxtPressAnyKeyToContinue,<span class="stringliteral">"[press any key to continue]\n"</span>);
<a name="l00059"></a>00059         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTxtPressAnyKeyToContinue);
<a name="l00060"></a>00060         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Getch();
<a name="l00061"></a>00061         <span class="comment">// Create an object of the CProducer class.</span>
<a name="l00062"></a>00062         <a class="code" href="class_c_producer.html">CProducer</a>* prod = <a class="code" href="class_c_producer.html#3897c9436f1aae1654b3ae1c5a4b6673">CProducer::NewL</a>(<a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>,tokens);
<a name="l00063"></a>00063         CleanupStack::PushL(prod);
<a name="l00064"></a>00064 
<a name="l00065"></a>00065         <span class="comment">// Print the KTextInvokeConsumer string and wait for a key press.</span>
<a name="l00066"></a>00066         _LIT(KTextInvokeConsumer,<span class="stringliteral">"Creating and starting the Consumer Thread...[This consumes a token every second]\n"</span>);
<a name="l00067"></a>00067         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTextInvokeConsumer);
<a name="l00068"></a>00068         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTxtPressAnyKeyToContinue);
<a name="l00069"></a>00069         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Getch();
<a name="l00070"></a>00070 
<a name="l00071"></a>00071         <span class="comment">// Create an object of the CConsumer class.</span>
<a name="l00072"></a>00072         <a class="code" href="class_c_consumer.html">CConsumer</a>* cons = <a class="code" href="class_c_consumer.html#7ba476d5a42cbd16448b540867bd141b">CConsumer::NewL</a>(<a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>,tokens);
<a name="l00073"></a>00073         CleanupStack::PushL(cons);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075         <span class="comment">// Create an object of the CUserInterface class.</span>
<a name="l00076"></a>00076         <span class="comment">// This handles key press requests from the console.</span>
<a name="l00077"></a>00077         <a class="code" href="class_c_user_interface.html">CUserInterface</a>* ui = <a class="code" href="class_c_user_interface.html#cb29c660858994d24137bb413fee4af8">CUserInterface::NewL</a>(<a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>,prod);
<a name="l00078"></a>00078         CleanupStack::PushL(ui);
<a name="l00079"></a>00079         
<a name="l00080"></a>00080         _LIT(KTextStartAS,<span class="stringliteral">"Starting the active scheduler...\n"</span>);
<a name="l00081"></a>00081         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTextStartAS);
<a name="l00082"></a>00082         <span class="comment">// Issue an asynchronous read request.</span>
<a name="l00083"></a>00083         ui-&gt;<a class="code" href="class_c_user_interface.html#9f9158c56f74b7c8da6c527f346c9952">ReadFunc</a>();
<a name="l00084"></a>00084         <span class="comment">// Start the active scheduler.</span>
<a name="l00085"></a>00085         CActiveScheduler::Start();
<a name="l00086"></a>00086 
<a name="l00087"></a>00087         CleanupStack::PopAndDestroy(5,scheduler);
<a name="l00088"></a>00088         }
<a name="l00089"></a>00089 
<a name="l00090"></a><a class="code" href="condvarlocal_8cpp.html#0f358e9c4355138f629b8c4f37310295">00090</a> GLDEF_C TInt <a class="code" href="dbllist_8cpp.html#0f358e9c4355138f629b8c4f37310295">E32Main</a>()
<a name="l00091"></a>00091     {
<a name="l00092"></a>00092         __UHEAP_MARK;
<a name="l00093"></a>00093         CTrapCleanup* cleanup=CTrapCleanup::New();
<a name="l00094"></a>00094         TRAPD(<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>,callExampleL());
<a name="l00095"></a>00095         <span class="keyword">delete</span> cleanup;
<a name="l00096"></a>00096         __ASSERT_ALWAYS(!<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>,User::Panic(KTxtEPOC32EX,<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>));
<a name="l00097"></a>00097         __UHEAP_MARKEND;
<a name="l00098"></a>00098         <span class="keywordflow">return</span> 0;
<a name="l00099"></a>00099     }
<a name="l00100"></a>00100 
<a name="l00101"></a>00101 LOCAL_C <span class="keywordtype">void</span> callExampleL()
<a name="l00102"></a>00102     {
<a name="l00103"></a>00103         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>=Console::NewL(KTxtExampleCode,TSize(KConsFullScreen,KConsFullScreen));
<a name="l00104"></a>00104         CleanupStack::PushL(<a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>);
<a name="l00105"></a>00105         TRAPD(<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>,<a class="code" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp.html#feaed5465c78704271678cde943d7e8a">DoExampleL</a>());
<a name="l00106"></a>00106         <span class="keywordflow">if</span> (<a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>)
<a name="l00107"></a>00107                 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KFormatFailed, <a class="code" href="_camera___app_ui_8cpp.html#711e7d3cb49b7e0de7880fed269134d3">error</a>);
<a name="l00108"></a>00108         <span class="keywordflow">else</span>
<a name="l00109"></a>00109                 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTxtOK);
<a name="l00110"></a>00110         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KTxtPressAnyKey);
<a name="l00111"></a>00111         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Getch();
<a name="l00112"></a>00112         CleanupStack::PopAndDestroy();
<a name="l00113"></a>00113     }
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:56 2010 for TB10.1 Example Applications by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>