Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_run_complete_8cpp-source.html
changeset 1 25a17d01db0c
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
       
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
       
     3 <title>TB10.1 Example Applications: examples/Base/IPC/Async/RunComplete/RunComplete.cpp Source File</title>
       
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
       
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
       
     6 </head><body>
       
     7 <!-- Generated by Doxygen 1.5.3 -->
       
     8 <h1>examples/Base/IPC/Async/RunComplete/RunComplete.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
       
     9 <a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
       
    10 <a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
       
    11 <a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
       
    12 <a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
       
    13 <a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
       
    14 <a name="l00007"></a>00007 <span class="comment">//</span>
       
    15 <a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
       
    16 <a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
       
    17 <a name="l00010"></a>00010 <span class="comment">//</span>
       
    18 <a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
       
    19 <a name="l00012"></a>00012 <span class="comment">//</span>
       
    20 <a name="l00013"></a>00013 <span class="comment">// Description:</span>
       
    21 <a name="l00014"></a>00014 <span class="comment">// Demonstrates asynchronous keyboard processing with messenger program.</span>
       
    22 <a name="l00015"></a>00015 <span class="comment">// Uses a single CMessageTimer active object which runs until completion.</span>
       
    23 <a name="l00016"></a>00016 <span class="comment">//</span>
       
    24 <a name="l00017"></a>00017 
       
    25 <a name="l00018"></a>00018 <span class="preprocessor">#include "CommonFramework.h"</span>
       
    26 <a name="l00019"></a>00019 
       
    27 <a name="l00020"></a>00020 <span class="comment">// panics</span>
       
    28 <a name="l00021"></a>00021 <span class="keyword">enum</span>
       
    29 <a name="l00022"></a>00022         {
       
    30 <a name="l00023"></a>00023         EPanicAlreadyActive=1000,
       
    31 <a name="l00024"></a>00024         };
       
    32 <a name="l00025"></a>00025 
       
    33 <a name="l00026"></a>00026 
       
    34 <a name="l00028"></a>00028 <span class="comment">//</span>
       
    35 <a name="l00029"></a>00029 <span class="comment">// -----&gt; CTimedMessenger (definition)</span>
       
    36 <a name="l00030"></a>00030 <span class="comment">//</span>
       
    37 <a name="l00032"></a>00032 <span class="comment"></span><span class="keyword">class </span>CTimedMessenger : <span class="keyword">public</span> CTimer
       
    38 <a name="l00033"></a>00033         {
       
    39 <a name="l00034"></a>00034 <span class="keyword">public</span>:
       
    40 <a name="l00035"></a>00035           <span class="comment">// Construction</span>
       
    41 <a name="l00036"></a>00036         CTimedMessenger();
       
    42 <a name="l00037"></a>00037       <span class="comment">// Destruction</span>
       
    43 <a name="l00038"></a>00038         ~CTimedMessenger();
       
    44 <a name="l00039"></a>00039 
       
    45 <a name="l00040"></a>00040 <span class="keyword">public</span>:
       
    46 <a name="l00041"></a>00041           <span class="comment">// Static construction</span>
       
    47 <a name="l00042"></a>00042         <span class="keyword">static</span> CTimedMessenger* NewLC(<span class="keyword">const</span> TDesC&amp; aGreeting,
       
    48 <a name="l00043"></a>00043                                           TInt aTicksRequested,
       
    49 <a name="l00044"></a>00044                                                                   TInt aTicksInterval
       
    50 <a name="l00045"></a>00045                                                                  );
       
    51 <a name="l00046"></a>00046         <span class="keyword">static</span> CTimedMessenger* NewL(<span class="keyword">const</span> TDesC&amp; aGreeting,
       
    52 <a name="l00047"></a>00047                                          TInt aTicksRequested,
       
    53 <a name="l00048"></a>00048                                                                  TInt aTicksInterval
       
    54 <a name="l00049"></a>00049                                                                 );
       
    55 <a name="l00050"></a>00050 
       
    56 <a name="l00051"></a>00051 <span class="keyword">public</span>:
       
    57 <a name="l00052"></a>00052           <span class="comment">// Second phase construction</span>
       
    58 <a name="l00053"></a>00053         <span class="keywordtype">void</span> ConstructL(<span class="keyword">const</span> TDesC&amp; aGreeting,
       
    59 <a name="l00054"></a>00054                             TInt aTicksRequested,
       
    60 <a name="l00055"></a>00055                                         TInt aTicksInterval
       
    61 <a name="l00056"></a>00056                                    );
       
    62 <a name="l00057"></a>00057 
       
    63 <a name="l00058"></a>00058           <span class="comment">// issue request</span>
       
    64 <a name="l00059"></a>00059         <span class="keywordtype">void</span> IssueRequest(); 
       
    65 <a name="l00060"></a>00060 
       
    66 <a name="l00061"></a>00061           <span class="comment">// Cancel request</span>
       
    67 <a name="l00062"></a>00062           <span class="comment">// Defined as pure virtual by CActive;</span>
       
    68 <a name="l00063"></a>00063           <span class="comment">// implementation provided by this class.</span>
       
    69 <a name="l00064"></a>00064         <span class="keywordtype">void</span> DoCancel();
       
    70 <a name="l00065"></a>00065 
       
    71 <a name="l00066"></a>00066           <span class="comment">// service completed request.</span>
       
    72 <a name="l00067"></a>00067           <span class="comment">// Defined as pure virtual by CActive;</span>
       
    73 <a name="l00068"></a>00068           <span class="comment">// implementation provided by this class.</span>
       
    74 <a name="l00069"></a>00069         <span class="keywordtype">void</span> RunL();
       
    75 <a name="l00070"></a>00070 
       
    76 <a name="l00071"></a>00071 <span class="keyword">public</span>:
       
    77 <a name="l00072"></a>00072           <span class="comment">// data members defined by this class</span>
       
    78 <a name="l00073"></a>00073         TBufC&lt;20&gt; iGreeting;   <span class="comment">// Text of the greeting.</span>
       
    79 <a name="l00074"></a>00074         TInt iTicksRequested;  <span class="comment">// Total number of greetings CTimedMessenger</span>
       
    80 <a name="l00075"></a>00075                                <span class="comment">// will emit.</span>
       
    81 <a name="l00076"></a>00076         TInt iTicksInterval;   <span class="comment">// Number of seconds between each greeting.</span>
       
    82 <a name="l00077"></a>00077         TInt iTicksDone;       <span class="comment">// Number of greetings issued so far.</span>
       
    83 <a name="l00078"></a>00078         };
       
    84 <a name="l00079"></a>00079 
       
    85 <a name="l00080"></a>00080 
       
    86 <a name="l00082"></a>00082 <span class="comment">//</span>
       
    87 <a name="l00083"></a>00083 <span class="comment">// -----&gt; CExampleScheduler (definition)</span>
       
    88 <a name="l00084"></a>00084 <span class="comment">//</span>
       
    89 <a name="l00086"></a>00086 <span class="comment"></span><span class="keyword">class </span>CExampleScheduler : <span class="keyword">public</span> CActiveScheduler
       
    90 <a name="l00087"></a>00087         {
       
    91 <a name="l00088"></a>00088 <span class="keyword">public</span>:
       
    92 <a name="l00089"></a>00089         <span class="keywordtype">void</span> Error (TInt aError) <span class="keyword">const</span>;
       
    93 <a name="l00090"></a>00090         };
       
    94 <a name="l00091"></a>00091 
       
    95 <a name="l00092"></a>00092 
       
    96 <a name="l00094"></a>00094 <span class="comment">//</span>
       
    97 <a name="l00095"></a>00095 <span class="comment">// -----&gt; CTimedMessenger (implementation)</span>
       
    98 <a name="l00096"></a>00096 <span class="comment">//</span>
       
    99 <a name="l00098"></a>00098 <span class="comment"></span>CTimedMessenger::CTimedMessenger()
       
   100 <a name="l00099"></a>00099         : CTimer(CActive::EPriorityStandard)
       
   101 <a name="l00100"></a>00100           <span class="comment">// Construct standard-priority active object</span>
       
   102 <a name="l00101"></a>00101         {};
       
   103 <a name="l00102"></a>00102 
       
   104 <a name="l00103"></a>00103 CTimedMessenger* CTimedMessenger::NewLC(<span class="keyword">const</span> TDesC&amp; aGreeting,
       
   105 <a name="l00104"></a>00104                                                                                 TInt aTicksRequested,
       
   106 <a name="l00105"></a>00105                                                                                 TInt aTicksInterval
       
   107 <a name="l00106"></a>00106                                                                            )
       
   108 <a name="l00107"></a>00107         {
       
   109 <a name="l00108"></a>00108         CTimedMessenger* <span class="keyword">self</span>=<span class="keyword">new</span> (ELeave) CTimedMessenger;
       
   110 <a name="l00109"></a>00109         CleanupStack::PushL(<span class="keyword">self</span>);
       
   111 <a name="l00110"></a>00110         <span class="keyword">self</span>-&gt;ConstructL(aGreeting,aTicksRequested,aTicksInterval);
       
   112 <a name="l00111"></a>00111         <span class="keywordflow">return</span> <span class="keyword">self</span>;
       
   113 <a name="l00112"></a>00112         }
       
   114 <a name="l00113"></a>00113 
       
   115 <a name="l00114"></a>00114 CTimedMessenger* CTimedMessenger::NewL(<span class="keyword">const</span> TDesC&amp; aGreeting,
       
   116 <a name="l00115"></a>00115                                                                    TInt aTicksRequested,
       
   117 <a name="l00116"></a>00116                                                                            TInt aTicksInterval
       
   118 <a name="l00117"></a>00117                                                                           )
       
   119 <a name="l00118"></a>00118         {
       
   120 <a name="l00119"></a>00119         CTimedMessenger* <span class="keyword">self</span> = <a class="code" href="class_c_thread_server.html#7c41592480f2c412599c332f52a61347">NewLC</a>(aGreeting,aTicksRequested,aTicksInterval);
       
   121 <a name="l00120"></a>00120         CleanupStack::Pop();
       
   122 <a name="l00121"></a>00121         <span class="keywordflow">return</span> <span class="keyword">self</span>;
       
   123 <a name="l00122"></a>00122         }
       
   124 <a name="l00123"></a>00123 
       
   125 <a name="l00124"></a>00124 <span class="keywordtype">void</span> CTimedMessenger::ConstructL(<span class="keyword">const</span> TDesC&amp; aGreeting,
       
   126 <a name="l00125"></a>00125                                                                  TInt aTicksRequested,
       
   127 <a name="l00126"></a>00126                                                                  TInt aTicksInterval
       
   128 <a name="l00127"></a>00127                                                                 )
       
   129 <a name="l00128"></a>00128         {
       
   130 <a name="l00129"></a>00129           <span class="comment">// Base class second-phase construction.</span>
       
   131 <a name="l00130"></a>00130         CTimer::ConstructL();
       
   132 <a name="l00131"></a>00131           <span class="comment">// Set members from arguments</span>
       
   133 <a name="l00132"></a>00132         iGreeting       = aGreeting;       <span class="comment">// Set greeting text.</span>
       
   134 <a name="l00133"></a>00133         iTicksRequested = aTicksRequested; <span class="comment">// Ticks requested</span>
       
   135 <a name="l00134"></a>00134         iTicksInterval  = aTicksInterval;  <span class="comment">// Interval between ticks</span>
       
   136 <a name="l00135"></a>00135           <span class="comment">// Add active object to active scheduler</span>
       
   137 <a name="l00136"></a>00136         CActiveScheduler::Add(<span class="keyword">this</span>); 
       
   138 <a name="l00137"></a>00137         }
       
   139 <a name="l00138"></a>00138 
       
   140 <a name="l00139"></a>00139 
       
   141 <a name="l00140"></a>00140 CTimedMessenger::~CTimedMessenger()
       
   142 <a name="l00141"></a>00141         {
       
   143 <a name="l00142"></a>00142           <span class="comment">// Make sure we're cancelled</span>
       
   144 <a name="l00143"></a>00143         Cancel();
       
   145 <a name="l00144"></a>00144         }
       
   146 <a name="l00145"></a>00145 
       
   147 <a name="l00146"></a>00146 <span class="keywordtype">void</span> CTimedMessenger::DoCancel()
       
   148 <a name="l00147"></a>00147         {
       
   149 <a name="l00148"></a>00148           <span class="comment">// Base class</span>
       
   150 <a name="l00149"></a>00149         CTimer::DoCancel(); 
       
   151 <a name="l00150"></a>00150           <span class="comment">// Reset this variable - needed if the object is re-activated later</span>
       
   152 <a name="l00151"></a>00151         iTicksDone = 0;
       
   153 <a name="l00152"></a>00152           <span class="comment">// Tell user</span>
       
   154 <a name="l00153"></a>00153         _LIT(KMsgCancelled,<span class="stringliteral">"Outstanding Messenger request cancelled\n"</span>);
       
   155 <a name="l00154"></a>00154         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KMsgCancelled); 
       
   156 <a name="l00155"></a>00155         }
       
   157 <a name="l00156"></a>00156 
       
   158 <a name="l00157"></a>00157 <span class="keywordtype">void</span> CTimedMessenger::IssueRequest()
       
   159 <a name="l00158"></a>00158         {
       
   160 <a name="l00159"></a>00159           <span class="comment">// There should never be an outstanding request at this point.</span>
       
   161 <a name="l00160"></a>00160         _LIT(KMsgAlreadyActive,<span class="stringliteral">"Is already Active"</span>);
       
   162 <a name="l00161"></a>00161         __ASSERT_ALWAYS(!IsActive(),User::Panic(KMsgAlreadyActive,EPanicAlreadyActive));
       
   163 <a name="l00162"></a>00162           <span class="comment">// Request another wait</span>
       
   164 <a name="l00163"></a>00163         CTimer::After( iTicksInterval*1000000);
       
   165 <a name="l00164"></a>00164         }
       
   166 <a name="l00165"></a>00165 
       
   167 <a name="l00166"></a>00166 <span class="keywordtype">void</span> CTimedMessenger::RunL()
       
   168 <a name="l00167"></a>00167         {
       
   169 <a name="l00168"></a>00168           <span class="comment">// Handle request completion</span>
       
   170 <a name="l00169"></a>00169           <span class="comment">// One more tick done</span>
       
   171 <a name="l00170"></a>00170         iTicksDone++;
       
   172 <a name="l00171"></a>00171           <span class="comment">// Print greeting</span>
       
   173 <a name="l00172"></a>00172         _LIT(KFormatString,<span class="stringliteral">"%S \n"</span>);
       
   174 <a name="l00173"></a>00173         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KFormatString,&amp;iGreeting);
       
   175 <a name="l00174"></a>00174           <span class="comment">// Issue new request, or stop if we have reached the limit</span>
       
   176 <a name="l00175"></a>00175         <span class="keywordflow">if</span> (iTicksDone  &lt; iTicksRequested)
       
   177 <a name="l00176"></a>00176                 {
       
   178 <a name="l00177"></a>00177                 IssueRequest();
       
   179 <a name="l00178"></a>00178                 }
       
   180 <a name="l00179"></a>00179         <span class="keywordflow">else</span>
       
   181 <a name="l00180"></a>00180                 {
       
   182 <a name="l00181"></a>00181                 _LIT(KMsgFinished,<span class="stringliteral">"Messenger finished \n"</span>);
       
   183 <a name="l00182"></a>00182                 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KMsgFinished);
       
   184 <a name="l00183"></a>00183                   <span class="comment">// Reset this variable - needed if the object is re-activated later</span>
       
   185 <a name="l00184"></a>00184                 iTicksDone=0;
       
   186 <a name="l00185"></a>00185                   <span class="comment">// Can now stop the active scheduler</span>
       
   187 <a name="l00186"></a>00186                 CActiveScheduler::Stop();
       
   188 <a name="l00187"></a>00187                 }
       
   189 <a name="l00188"></a>00188         }
       
   190 <a name="l00189"></a>00189 
       
   191 <a name="l00190"></a>00190 
       
   192 <a name="l00192"></a>00192 <span class="comment">//</span>
       
   193 <a name="l00193"></a>00193 <span class="comment">// -----&gt; CExampleScheduler (implementation)</span>
       
   194 <a name="l00194"></a>00194 <span class="comment">//</span>
       
   195 <a name="l00196"></a>00196 <span class="comment"></span><span class="keywordtype">void</span> CExampleScheduler::Error(TInt aError)<span class="keyword"> const</span>
       
   196 <a name="l00197"></a>00197 <span class="keyword">        </span>{
       
   197 <a name="l00198"></a>00198         _LIT(KMsgSchedErr,<span class="stringliteral">"CExampleScheduler-error"</span>);
       
   198 <a name="l00199"></a>00199         User::Panic(KMsgSchedErr,aError);
       
   199 <a name="l00200"></a>00200         }
       
   200 <a name="l00201"></a>00201 
       
   201 <a name="l00202"></a>00202 
       
   202 <a name="l00204"></a>00204 <span class="comment">//</span>
       
   203 <a name="l00205"></a>00205 <span class="comment">// Do the example</span>
       
   204 <a name="l00206"></a>00206 <span class="comment">//</span>
       
   205 <a name="l00208"></a>00208 <span class="comment"></span>LOCAL_C <span class="keywordtype">void</span> doExampleL()
       
   206 <a name="l00209"></a>00209     {
       
   207 <a name="l00210"></a>00210           <span class="comment">// Construct and install the active scheduler</span>
       
   208 <a name="l00211"></a>00211         CExampleScheduler*  exampleScheduler = <span class="keyword">new</span> (ELeave) CExampleScheduler;
       
   209 <a name="l00212"></a>00212 
       
   210 <a name="l00213"></a>00213           <span class="comment">// Push onto the cleanup stack</span>
       
   211 <a name="l00214"></a>00214         CleanupStack::PushL(exampleScheduler);
       
   212 <a name="l00215"></a>00215 
       
   213 <a name="l00216"></a>00216           <span class="comment">// Install as the active scheduler</span>
       
   214 <a name="l00217"></a>00217         CActiveScheduler::Install(exampleScheduler); 
       
   215 <a name="l00218"></a>00218 
       
   216 <a name="l00219"></a>00219       <span class="comment">// Create a CTimedMessenger active object which will emit 3 messages</span>
       
   217 <a name="l00220"></a>00220           <span class="comment">// with an interval of 2 seconds between messages</span>
       
   218 <a name="l00221"></a>00221         _LIT(KMsgExplanation,<span class="stringliteral">"A single CMessageTimer active object which runs until completion\n\n"</span>);
       
   219 <a name="l00222"></a>00222         <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>-&gt;Printf(KMsgExplanation);
       
   220 <a name="l00223"></a>00223         _LIT(KMsgGoodMorning,<span class="stringliteral">"Good Morning!"</span>);
       
   221 <a name="l00224"></a>00224         CTimedMessenger* myTimedMessage = CTimedMessenger::NewLC(KMsgGoodMorning,3,2);
       
   222 <a name="l00225"></a>00225 
       
   223 <a name="l00226"></a>00226           <span class="comment">// Issue the first request</span>
       
   224 <a name="l00227"></a>00227         myTimedMessage-&gt;IssueRequest();
       
   225 <a name="l00228"></a>00228 
       
   226 <a name="l00229"></a>00229       <span class="comment">// Main part of program is a wait loop</span>
       
   227 <a name="l00230"></a>00230           <span class="comment">// This function completes when the scheduler stops</span>
       
   228 <a name="l00231"></a>00231         CActiveScheduler::Start();
       
   229 <a name="l00232"></a>00232 
       
   230 <a name="l00233"></a>00233           <span class="comment">// Remove from the cleanup stack and destroy:</span>
       
   231 <a name="l00234"></a>00234           <span class="comment">// 1. the CTimedMessenger active object</span>
       
   232 <a name="l00235"></a>00235           <span class="comment">// 2. exampleScheduler</span>
       
   233 <a name="l00236"></a>00236         CleanupStack::PopAndDestroy(2); 
       
   234 <a name="l00237"></a>00237         }
       
   235 <a name="l00238"></a>00238 
       
   236 </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;
       
   237 <a href="http://www.doxygen.org/index.html">
       
   238 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
       
   239 </body>
       
   240 </html>