Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/taskexecutor_8cpp_source.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: examples/SysLibs/TaskSchedulerExample/taskexecutor.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/SysLibs/TaskSchedulerExample/taskexecutor.cpp</h1><a href="taskexecutor_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) 2007-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">// This is simple code that executes the task scheduled by the task scheduler. </span>
<a name="l00015"></a>00015 <span class="comment">// The code also checks if the task requester has the required capability.</span>
<a name="l00016"></a>00016 <span class="comment">// This window belongs to the task scheduled to execute by the main program. </span>
<a name="l00017"></a>00017 <span class="comment">// It shows the details of the task information passed by the Task Scheduler </span>
<a name="l00018"></a>00018 <span class="comment">// to the executed program. </span>
<a name="l00019"></a>00019 <span class="comment">//</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00026"></a>00026 <span class="preprocessor">#include <schtask.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <e32cons.h></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTaskConsoleName, <span class="stringliteral">"TaskExecutor"</span>);
<a name="l00030"></a>00030 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KContent,<span class="stringliteral">"\nContents of task file:\n"</span>);
<a name="l00031"></a>00031 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTask,<span class="stringliteral">"\nRunning task: %S"</span>);
<a name="l00032"></a>00032 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTaskData,<span class="stringliteral">"\nThis is the task data for a"</span>);
<a name="l00033"></a>00033 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTaskId,<span class="stringliteral">"\nThe task Id is: %d\n"</span>);
<a name="l00034"></a>00034 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KValidity,<span class="stringliteral">"Task is valid until %S\n"</span>);
<a name="l00035"></a>00035 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KDateString,<span class="stringliteral">"%H%:1%T %*E%*D%X%*N%Y %1 %2 %3"</span>);
<a name="l00036"></a>00036 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KPressAnyKey,<span class="stringliteral">"Press any key to continue \n"</span>);
<a name="l00037"></a>00037 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KAbort,<span class="stringliteral">"\nCapabilities of the task scheduler and the executor do not match. Task aborted\n"</span>);
<a name="l00038"></a>00038 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KSidMismatch,<span class="stringliteral">"SID of the task executor is not same as that of the scheduler. Task aborted\n"</span>);
<a name="l00039"></a>00039 <span class="comment">// Uid of the task requester</span>
<a name="l00040"></a>00040 <span class="keyword">const</span> TUint32 KTaskSchedulerSid = 0xE80000B5;
<a name="l00041"></a>00041 <span class="keyword">const</span> TCapability KTaskCapability = ECapabilityWriteDeviceData;
<a name="l00042"></a>00042
<a name="l00049"></a><a class="code" href="taskexecutor_8cpp.html#ad51792a4c3cfb76bbbd1f61050928332">00049</a> <span class="keywordtype">void</span> <a class="code" href="taskexecutor_8cpp.html#ad51792a4c3cfb76bbbd1f61050928332">TaskExecuteL</a>(RFile& aTaskFile)
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="comment">// Construct console</span>
<a name="l00052"></a>00052 CConsoleBase* console = Console::NewL(KTaskConsoleName, TSize(KConsFullScreen, KConsFullScreen));
<a name="l00053"></a>00053 CleanupStack::PushL(console);
<a name="l00054"></a>00054 console->Printf(KContent);
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">// Open the filestore</span>
<a name="l00057"></a>00057 CFileStore* store = CDirectFileStore::FromLC(aTaskFile);<span class="comment">//pushes store onto CleanupStack</span>
<a name="l00058"></a>00058 RStoreReadStream instream;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="comment">// Open the file containing the store</span>
<a name="l00061"></a>00061 instream.OpenLC(*store,store->Root());<span class="comment">//pushes instream onto CleanupStack</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">// Get task count</span>
<a name="l00064"></a>00064 TInt count = instream.ReadInt32L();
<a name="l00065"></a>00065 <span class="keywordflow">for</span> (TInt i=0;i<count;i++)
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067 CScheduledTask* task = CScheduledTask::NewLC(instream); <span class="comment">//pushes task onto CleanupStack</span>
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">// Check if this is the SID of task requester</span>
<a name="l00070"></a>00070 <span class="keywordflow">if</span>(task->SecurityInfo().iSecureId == KTaskSchedulerSid)
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">// Check if the requester has the necessary capability to run </span>
<a name="l00074"></a>00074 <span class="comment">// the scheduled tasks.</span>
<a name="l00075"></a>00075 <span class="keywordflow">if</span>(task->SecurityInfo().iCaps.HasCapability(KTaskCapability))
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 TBuf<50> buf;
<a name="l00078"></a>00078 buf.Format(KTask, &task->Info().iName);
<a name="l00079"></a>00079 console->Printf(buf);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 HBufC* data = <span class="keyword">const_cast<</span>HBufC*<span class="keyword">></span>(&(task->Data()));
<a name="l00082"></a>00082
<a name="l00083"></a>00083 console->Printf(KTaskData);
<a name="l00084"></a>00084 console->Printf(*data);
<a name="l00085"></a>00085
<a name="l00086"></a>00086 console->Printf(KTaskId,task->Info().iTaskId);
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">// Get the time when the task stops being valid</span>
<a name="l00089"></a>00089 TTsTime tstime = task->ValidUntil();
<a name="l00090"></a>00090 <span class="keyword">const</span> TTime time = tstime.GetLocalTime();
<a name="l00091"></a>00091 TBuf<30> dateString;
<a name="l00092"></a>00092 time.FormatL(dateString,(KDateString));
<a name="l00093"></a>00093 console->Printf(KValidity, &dateString);
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 <span class="keywordflow">else</span>
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 console->Printf(KAbort);
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 <span class="keywordflow">else</span>
<a name="l00101"></a>00101 {
<a name="l00102"></a>00102 console->Printf(KSidMismatch);
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 console->Printf(KPressAnyKey);
<a name="l00105"></a>00105 console->Getch();
<a name="l00106"></a>00106
<a name="l00107"></a>00107 CleanupStack::PopAndDestroy(task);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110
<a name="l00111"></a>00111 CleanupStack::PopAndDestroy(3); <span class="comment">// instream, store, console</span>
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113
<a name="l00114"></a>00114
<a name="l00115"></a>00115 TInt Execute()
<a name="l00116"></a>00116 {
<a name="l00117"></a>00117 TInt err = KErrNoMemory;
<a name="l00118"></a>00118 CTrapCleanup* cleanup = CTrapCleanup::New();
<a name="l00119"></a>00119 <span class="keywordflow">if</span> (cleanup)
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 RFile file;
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">// Needs to be called early-on to allow the task scheduler server</span>
<a name="l00124"></a>00124 <span class="comment">// to adopt the already open task file from the task scheduler</span>
<a name="l00125"></a>00125 err = file.AdoptFromCreator(TScheduledTaskFile::FsHandleIndex(),
<a name="l00126"></a>00126 TScheduledTaskFile::FileHandleIndex());
<a name="l00127"></a>00127 <span class="keywordflow">if</span> (err != KErrNone)
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129 <span class="keywordflow">return</span> err;
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// Execute </span>
<a name="l00133"></a>00133 TRAPD(err,<a class="code" href="taskexecutor_8cpp.html#ad51792a4c3cfb76bbbd1f61050928332">TaskExecuteL</a>(file));
<a name="l00134"></a>00134 <span class="keywordflow">if</span>(err != KErrNone)
<a name="l00135"></a>00135 {
<a name="l00136"></a>00136 User::Panic(_L(<span class="stringliteral">"Failed to complete"</span>),err);
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">// Close the file</span>
<a name="l00140"></a>00140 file.Close();
<a name="l00141"></a>00141 <span class="keyword">delete</span> cleanup;
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143 <span class="keywordflow">return</span> err;
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146
<a name="l00147"></a><a class="code" href="taskexecutor_8cpp.html#a0f358e9c4355138f629b8c4f37310295">00147</a> GLDEF_C TInt E32Main()
<a name="l00148"></a>00148 {
<a name="l00149"></a>00149 <span class="keywordflow">return</span> Execute();
<a name="l00150"></a>00150 }
</pre></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>