Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/subscribespec_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/Base/IPC/pubsub/subscribespec.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/pubsub/subscribespec.cpp</h1><a href="subscribespec_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">// Demonstrates the speculative pattern of subscribing to a byte-array property</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 "<a class="code" href="subscribe_8h.html">subscribe.h</a>"</span>
<a name="l00024"></a>00024 LOCAL_D CConsoleBase* console;
<a name="l00025"></a>00025
<a name="l00029"></a>00029 CArrayPropertyWatch::CArrayPropertyWatch():CActive(EPriority)
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031 }
<a name="l00032"></a>00032
<a name="l00037"></a>00037 <span class="keywordtype">void</span> CArrayPropertyWatch::ConstructL(CConsoleBase* aConsole)
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 User::LeaveIfError(iProperty.Attach(KMyPropertyCat,KMyPropertyName));
<a name="l00040"></a>00040 iConsole = aConsole;
<a name="l00041"></a>00041 CActiveScheduler::Add(<span class="keyword">this</span>);
<a name="l00042"></a>00042 }
<a name="l00043"></a>00043
<a name="l00049"></a><a class="code" href="class_c_array_property_watch.html#a54b576da65400b50b8845f0ea8ad5c8e">00049</a> <a class="code" href="class_c_array_property_watch.html">CArrayPropertyWatch</a>* <a class="code" href="class_c_array_property_watch.html#a54b576da65400b50b8845f0ea8ad5c8e">CArrayPropertyWatch::NewL</a>(CConsoleBase* aConsole)
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <a class="code" href="class_c_array_property_watch.html">CArrayPropertyWatch</a>* <span class="keyword">self</span> = <span class="keyword">new</span> (ELeave) <a class="code" href="class_c_array_property_watch.html">CArrayPropertyWatch</a>;
<a name="l00052"></a>00052 CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00053"></a>00053 <span class="keyword">self</span>->ConstructL(aConsole);
<a name="l00054"></a>00054 CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00055"></a>00055 <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057
<a name="l00061"></a>00061 CArrayPropertyWatch::~CArrayPropertyWatch()
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 iProperty.Close();
<a name="l00064"></a>00064 <span class="comment">// Delete the property as it is no longer required by the subscriber</span>
<a name="l00065"></a>00065 RProperty::Delete(KMyPropertyCat, KMyPropertyName);
<a name="l00066"></a>00066 Cancel();
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068
<a name="l00072"></a>00072 <span class="keywordtype">void</span> CArrayPropertyWatch::DoCancel()
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074 iProperty.Cancel();
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00081"></a>00081 <span class="keywordtype">void</span> CArrayPropertyWatch::RunL()
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 <span class="comment">// Get the value of the property</span>
<a name="l00084"></a>00084 TBuf16<KArraySize> buf;
<a name="l00085"></a>00085 TInt err = iProperty.Get(buf);
<a name="l00086"></a>00086 <span class="keywordflow">if</span>(err == KErrNotFound)
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 <span class="comment">// Leave the function if the property is not defined</span>
<a name="l00089"></a>00089 CActiveScheduler::Stop();
<a name="l00090"></a>00090 User::Leave(err);
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 <span class="keywordflow">else</span>
<a name="l00093"></a>00093 {
<a name="l00094"></a>00094 <span class="comment">// Print the value of the property</span>
<a name="l00095"></a>00095 PrintProperty(buf);
<a name="l00096"></a>00096 <span class="keywordflow">if</span>(buf == KStop)
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 CActiveScheduler::Stop();
<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 <span class="comment">// Re-subscribe to the property</span>
<a name="l00103"></a>00103 iProperty.Subscribe(iStatus);
<a name="l00104"></a>00104 SetActive();
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 }
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108
<a name="l00113"></a>00113 <span class="keywordtype">void</span> CArrayPropertyWatch::PrintProperty(TDes16& aBuf)
<a name="l00114"></a>00114 {
<a name="l00115"></a>00115 iConsole->Printf(KTxtArray);
<a name="l00116"></a>00116 TInt bufLength = aBuf.Length();
<a name="l00117"></a>00117 <span class="keywordflow">for</span>(TInt ix = 0; ix < bufLength;ix++)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 iConsole->Printf(KTxtArrayElement,aBuf[ix]);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 iConsole->Printf(KTxtNewLine);
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123
<a name="l00127"></a><a class="code" href="class_c_array_property_watch.html#a784e62d027f834bd052b4d0a2a84f0c3">00127</a> <span class="keywordtype">void</span> <a class="code" href="class_c_array_property_watch.html#a784e62d027f834bd052b4d0a2a84f0c3">CArrayPropertyWatch::DefinePropertyL</a>()
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129 iConsole->Printf(KTxtDefine);
<a name="l00130"></a>00130 <span class="comment">// Define the property</span>
<a name="l00131"></a>00131 TInt err = RProperty::Define(KMyPropertyCat, KMyPropertyName,RProperty::EByteArray,KAllowAllPolicy,KAllowAllPolicy,KArraySize);
<a name="l00132"></a>00132 <span class="keywordflow">if</span>(err == KErrAlreadyExists || err == KErrNone)
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134 <span class="comment">// Ignore the KErrAlreadyExists error code</span>
<a name="l00135"></a>00135 TBuf16<KArraySize> buf;
<a name="l00136"></a>00136 <span class="comment">// Returns the default value of the property</span>
<a name="l00137"></a>00137 <span class="comment">// Ignore this value</span>
<a name="l00138"></a>00138 err = iProperty.Get(buf);
<a name="l00139"></a>00139 User::LeaveIfError(err);
<a name="l00140"></a>00140 <span class="comment">// Subscribe to the property and maintain an outstanding request</span>
<a name="l00141"></a>00141 iProperty.Subscribe(iStatus);
<a name="l00142"></a>00142 SetActive();
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 <span class="keywordflow">else</span>
<a name="l00145"></a>00145 {
<a name="l00146"></a>00146 <span class="comment">// Leave in case of errors other than KErrAlreadyExists</span>
<a name="l00147"></a>00147 User::Leave(err);
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keywordtype">void</span> DoExampleL()
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 CActiveScheduler* scheduler = <span class="keyword">new</span> (ELeave) CActiveScheduler();
<a name="l00154"></a>00154 CleanupStack::PushL(scheduler);
<a name="l00155"></a>00155 CActiveScheduler::Install(scheduler);
<a name="l00156"></a>00156
<a name="l00157"></a>00157 console->Printf(KTxtSpecSub);
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">// Create the byte-array property watch active object</span>
<a name="l00160"></a>00160 <a class="code" href="class_c_array_property_watch.html">CArrayPropertyWatch</a>* obj = <a class="code" href="class_c_array_property_watch.html#a54b576da65400b50b8845f0ea8ad5c8e">CArrayPropertyWatch::NewL</a>(console);
<a name="l00161"></a>00161 CleanupStack::PushL(obj);
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// Subscribe to the property and start the scheduler</span>
<a name="l00164"></a>00164 obj-><a class="code" href="class_c_array_property_watch.html#a784e62d027f834bd052b4d0a2a84f0c3">DefinePropertyL</a>();
<a name="l00165"></a>00165 CActiveScheduler::Start();
<a name="l00166"></a>00166
<a name="l00167"></a>00167 CleanupStack::PopAndDestroy(obj);
<a name="l00168"></a>00168 CleanupStack::PopAndDestroy(scheduler);
<a name="l00169"></a>00169 }
<a name="l00170"></a>00170
<a name="l00171"></a><a class="code" href="subscribespec_8cpp.html#a0f358e9c4355138f629b8c4f37310295">00171</a> GLDEF_C TInt E32Main()
<a name="l00172"></a>00172 {
<a name="l00173"></a>00173 __UHEAP_MARK;
<a name="l00174"></a>00174 CTrapCleanup* cleanup = CTrapCleanup::New();
<a name="l00175"></a>00175
<a name="l00176"></a>00176 TRAPD(createError, console = Console::NewL(KTextConsoleTitle, TSize(KConsFullScreen,KConsFullScreen)));
<a name="l00177"></a>00177 <span class="keywordflow">if</span> (createError)
<a name="l00178"></a>00178 <span class="keywordflow">return</span> createError;
<a name="l00179"></a>00179
<a name="l00180"></a>00180 TRAPD(mainError, DoExampleL());
<a name="l00181"></a>00181 <span class="keywordflow">if</span> (mainError)
<a name="l00182"></a>00182 console->Printf(KTextFailed, mainError);
<a name="l00183"></a>00183 console->Printf(KTextPressAnyKey);
<a name="l00184"></a>00184 console->Getch();
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="keyword">delete</span> console;
<a name="l00187"></a>00187 <span class="keyword">delete</span> cleanup;
<a name="l00188"></a>00188 __UHEAP_MARKEND;
<a name="l00189"></a>00189 <span class="keywordflow">return</span> KErrNone;
<a name="l00190"></a>00190 }
</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>