Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/publishspec_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/publishspec.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/publishspec.cpp</h1><a href="publishspec_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 publishing pattern of 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="publish_8h.html">publish.h</a>"</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 LOCAL_D CConsoleBase* console;
<a name="l00026"></a>00026
<a name="l00032"></a><a class="code" href="publishspec_8cpp.html#ae3dba9d5ec6d59791d61680c67729f0e">00032</a> <span class="keywordtype">void</span> <a class="code" href="publish_8h.html#ae3dba9d5ec6d59791d61680c67729f0e">PublishL</a>(RProperty& aProperty,TDes16& aBuf)
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 TInt bufLength = aBuf.Length();
<a name="l00035"></a>00035 console->Printf(KTxtPublish);
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">// Publish the property and handle the value returned appropriately</span>
<a name="l00038"></a>00038 <span class="comment">// Ignore the KErrNotFound error</span>
<a name="l00039"></a>00039 TInt err = aProperty.Set(aBuf);
<a name="l00040"></a>00040 <span class="keywordflow">switch</span>(err)
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="comment">// No error, property is defined</span>
<a name="l00043"></a>00043 <span class="keywordflow">case</span> KErrNone:
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="comment">// Print array elements</span>
<a name="l00046"></a>00046 console->Printf(KTxtArray);
<a name="l00047"></a>00047 <span class="keywordflow">for</span>(TInt ix = 0; ix < bufLength; ix++)
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 console->Printf(KTxtArrayElement,aBuf[ix]);
<a name="l00050"></a>00050 }
<a name="l00051"></a>00051 console->Printf(KTxtNewLine);
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053 <span class="keywordflow">break</span>;
<a name="l00054"></a>00054 <span class="comment">// Property is not defined, ignore this error</span>
<a name="l00055"></a>00055 <span class="keywordflow">case</span> KErrNotFound:
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 console->Printf(KTxtNotFound);
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059 <span class="keywordflow">break</span>;
<a name="l00060"></a>00060 <span class="comment">// Leave if any other errors are returned</span>
<a name="l00061"></a>00061 <span class="keywordflow">default</span>:
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 User::LeaveIfError(err);
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keywordtype">void</span> DoExampleL()
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 console->Printf(KTxtSpecPublish);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 RProperty myProperty;
<a name="l00073"></a>00073 console->Printf(KTxtCreateHandle);
<a name="l00074"></a>00074 <span class="comment">// Create a handle to the property</span>
<a name="l00075"></a>00075 User::LeaveIfError(myProperty.Attach(KMyPropertyCat,KMyPropertyName,EOwnerThread));
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">// Byte-Array to be published</span>
<a name="l00078"></a>00078 TUint16 array[KArraySize] = {10,20,30,40};
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">// Descriptor that the array contents are copied into</span>
<a name="l00081"></a>00081 TBuf16<KBufSize> buf;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="comment">// Copy array contents into the descriptor</span>
<a name="l00084"></a>00084 buf.Copy(&array[0],<span class="keyword">sizeof</span>(array));
<a name="l00085"></a>00085 buf.SetLength(KArraySize);
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">// Publish the property</span>
<a name="l00088"></a>00088 <a class="code" href="publish_8h.html#ae3dba9d5ec6d59791d61680c67729f0e">PublishL</a>(myProperty,buf);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">// Change the array contents</span>
<a name="l00091"></a>00091 array[0] = 0x00ab;
<a name="l00092"></a>00092 array[1] = 0x00bc;
<a name="l00093"></a>00093 array[2] = 0x00cd;
<a name="l00094"></a>00094 array[3] = 0x00de;
<a name="l00095"></a>00095 array[4] = 0x00ef;
<a name="l00096"></a>00096 array[5] = 0x00fa;
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment">// Copy array contents into the descriptor</span>
<a name="l00099"></a>00099 buf.Copy(&array[0],<span class="keyword">sizeof</span>(array));
<a name="l00100"></a>00100 buf.SetLength(KArraySize);
<a name="l00101"></a>00101 console->Printf(KTxtEnter);
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">// Wait for a key press</span>
<a name="l00104"></a>00104 <span class="keywordflow">while</span>(console->Getch()!= EKeyEnter)
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 console->Printf(KTxtEnter);
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">// Publish the property</span>
<a name="l00110"></a>00110 <a class="code" href="publish_8h.html#ae3dba9d5ec6d59791d61680c67729f0e">PublishL</a>(myProperty,buf);
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// Indicate the publisher will not publish any more values</span>
<a name="l00113"></a>00113 buf.Copy(KStop);
<a name="l00114"></a>00114 console->Printf(KTxtEnter);
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">// Wait for a key press</span>
<a name="l00117"></a>00117 <span class="keywordflow">while</span>(console->Getch()!= EKeyEnter)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 console->Printf(KTxtEnter);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="comment">// Publish the property</span>
<a name="l00123"></a>00123 <a class="code" href="publish_8h.html#ae3dba9d5ec6d59791d61680c67729f0e">PublishL</a>(myProperty,buf);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">// Close the handle</span>
<a name="l00126"></a>00126 myProperty.Close();
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128
<a name="l00129"></a><a class="code" href="publishspec_8cpp.html#a0f358e9c4355138f629b8c4f37310295">00129</a> GLDEF_C TInt E32Main()
<a name="l00130"></a>00130 {
<a name="l00131"></a>00131 __UHEAP_MARK;
<a name="l00132"></a>00132 CTrapCleanup* cleanup = CTrapCleanup::New();
<a name="l00133"></a>00133
<a name="l00134"></a>00134 TRAPD(createError, console = Console::NewL(KTextConsoleTitle, TSize(KConsFullScreen,KConsFullScreen)));
<a name="l00135"></a>00135 <span class="keywordflow">if</span> (createError)
<a name="l00136"></a>00136 <span class="keywordflow">return</span> createError;
<a name="l00137"></a>00137
<a name="l00138"></a>00138 TRAPD(mainError, DoExampleL());
<a name="l00139"></a>00139 <span class="keywordflow">if</span> (mainError)
<a name="l00140"></a>00140 console->Printf(KTextFailed, mainError);
<a name="l00141"></a>00141 console->Printf(KTextPressAnyKey);
<a name="l00142"></a>00142 console->Getch();
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keyword">delete</span> console;
<a name="l00145"></a>00145 <span class="keyword">delete</span> cleanup;
<a name="l00146"></a>00146 __UHEAP_MARKEND;
<a name="l00147"></a>00147 <span class="keywordflow">return</span> KErrNone;
<a name="l00148"></a>00148 }
</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>