Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_other_buffers_8cpp_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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/ForumNokia/DescriptorExample/src/OtherBuffers.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/ForumNokia/DescriptorExample/src/OtherBuffers.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2008 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004 
<a name="l00005"></a>00005 <span class="preprocessor">#include &lt;e32std.h&gt;</span>
<a name="l00006"></a>00006 <span class="preprocessor">#include &lt;e32base.h&gt;</span>
<a name="l00007"></a>00007 <span class="preprocessor">#include &quot;DescriptorExamples.h&quot;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &quot;StringRenderer.h&quot;</span>
<a name="l00009"></a>00009 
<a name="l00010"></a>00010 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00011"></a>00011 <span class="comment">// The example class above and helper functions are used by examples.</span>
<a name="l00012"></a>00012 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00013"></a>00013     <span class="keyword">class </span>TExample
<a name="l00014"></a>00014         {
<a name="l00015"></a>00015         <span class="keyword">public</span>:
<a name="l00016"></a>00016             TExample() : iNumber(0), iText() {}
<a name="l00017"></a>00017             TExample(TInt aNumber, <span class="keyword">const</span> TDesC &amp;aText);
<a name="l00018"></a>00018         <span class="keyword">public</span>:
<a name="l00019"></a>00019             TInt iNumber;
<a name="l00020"></a>00020             TBuf&lt;16&gt; iText;
<a name="l00021"></a>00021         };
<a name="l00022"></a>00022 
<a name="l00023"></a>00023     <span class="comment">// render message and characteristics of TExample class</span>
<a name="l00024"></a>00024     <span class="comment">// e.g. &#39;message: 10, &quot;abcd&quot;&#39;</span>
<a name="l00025"></a>00025     LOCAL_C <span class="keywordtype">void</span> ShowContents(<span class="keyword">const</span> TDesC &amp;aMsg,
<a name="l00026"></a>00026                               <span class="keyword">const</span> TExample aExample,
<a name="l00027"></a>00027                               TPtr &amp;aOutput );
<a name="l00028"></a>00028 
<a name="l00029"></a>00029     <span class="comment">// render message and contents of given descriptor character data,</span>
<a name="l00030"></a>00030     <span class="comment">// e.g. &#39;message: &quot;abcd&quot;&#39;</span>
<a name="l00031"></a>00031     LOCAL_C <span class="keywordtype">void</span> ShowContents(<span class="keyword">const</span> TDesC &amp;aMsg,
<a name="l00032"></a>00032                               <span class="keyword">const</span> TDesC &amp;aTxt,
<a name="l00033"></a>00033                               TPtr &amp;aOutput);
<a name="l00034"></a>00034 
<a name="l00035"></a>00035     <span class="comment">// render message and contents of given descriptor character data,</span>
<a name="l00036"></a>00036     <span class="comment">// e.g. &#39;message: &quot;abcd&quot;&#39;</span>
<a name="l00037"></a>00037     LOCAL_C <span class="keywordtype">void</span> ShowContents(<span class="keyword">const</span> TDesC &amp;aMsg,
<a name="l00038"></a>00038                               <span class="keyword">const</span> TDesC8 &amp;aTxt,
<a name="l00039"></a>00039                               TPtr &amp;aOutput);
<a name="l00040"></a>00040 
<a name="l00041"></a>00041     <span class="comment">// render number of items in fifo and maximum number of</span>
<a name="l00042"></a>00042     <span class="comment">// items the given fifo can store. e.g. &#39;fifo: size=1, max=5&#39;.</span>
<a name="l00043"></a>00043     <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;
<a name="l00044"></a>00044     LOCAL_C <span class="keywordtype">void</span> ShowContents(CCirBuf&lt;T&gt; *aFIFO, TPtr &amp;aOutput);
<a name="l00045"></a>00045 
<a name="l00046"></a>00046     <span class="comment">// Render characteristics of flat dynamic buffer storing 8 bit characters.</span>
<a name="l00047"></a>00047     <span class="comment">// The result is similar to this example:</span>
<a name="l00048"></a>00048     <span class="comment">//</span>
<a name="l00049"></a>00049     <span class="comment">//   CBufFlat: size=8, data @13984184=</span>
<a name="l00050"></a>00050     <span class="comment">//   &quot;abcdefgh&quot;</span>
<a name="l00051"></a>00051     <span class="comment">//</span>
<a name="l00052"></a>00052     LOCAL_C <span class="keywordtype">void</span> ShowBuf(CBufFlat &amp;aBuf, TDes &amp;aOutput);
<a name="l00053"></a>00053 
<a name="l00054"></a>00054     <span class="comment">// Render characteristics of segmented dynamic buffer storing 8 bit</span>
<a name="l00055"></a>00055     <span class="comment">// characters. The result is similar to this example:</span>
<a name="l00056"></a>00056     <span class="comment">//</span>
<a name="l00057"></a>00057     <span class="comment">// CBufSeg: size=28, segments=</span>
<a name="l00058"></a>00058     <span class="comment">//   &quot;abcdefghij&quot; @13984212</span>
<a name="l00059"></a>00059     <span class="comment">//   &quot;klmnopqrst&quot; @13984248</span>
<a name="l00060"></a>00060     <span class="comment">//   &quot;uvwxyz01&quot; @13984284</span>
<a name="l00061"></a>00061     <span class="comment">//</span>
<a name="l00062"></a>00062     LOCAL_C <span class="keywordtype">void</span> ShowBuf(CBufSeg &amp;aBuf, TDes &amp;aOutput);
<a name="l00063"></a>00063 
<a name="l00064"></a>00064     <span class="comment">// Render characteristics of package buffer storing TExample object.</span>
<a name="l00065"></a>00065     <span class="comment">// The result is similar to this example:</span>
<a name="l00066"></a>00066     <span class="comment">//</span>
<a name="l00067"></a>00067     <span class="comment">//  TPckgBuf @309000944, sizeof=52, storing</span>
<a name="l00068"></a>00068     <span class="comment">//    TExample @309000952, sizeof=44, iNumber=1234567, iText=&quot;Hello!&quot;</span>
<a name="l00069"></a>00069     <span class="comment">//</span>
<a name="l00070"></a>00070     LOCAL_C <span class="keywordtype">void</span> ShowContents(TPckgBuf&lt;TExample&gt; &amp;aPackageBuf, TPtr &amp;aOutput);
<a name="l00071"></a>00071 
<a name="l00072"></a>00072     <span class="comment">// Render characteristics of package buffer pointer referring to TExample</span>
<a name="l00073"></a>00073     <span class="comment">// object. The result is similar to this example:</span>
<a name="l00074"></a>00074     <span class="comment">//</span>
<a name="l00075"></a>00075     <span class="comment">//  TPckg @309000932, sizeof=12, referring to</span>
<a name="l00076"></a>00076     <span class="comment">//    TExample @309001012, sizeof=44, iNumber=12345, iText=&quot;Hello!&quot;</span>
<a name="l00077"></a>00077     <span class="comment">//</span>
<a name="l00078"></a>00078     LOCAL_C <span class="keywordtype">void</span> ShowContents(TPckg&lt;TExample&gt; &amp;aPackage, TPtr &amp;aOutput);
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 <span class="comment">// Texts for adding and removing operations</span>
<a name="l00081"></a>00081 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KAddedMsg, <span class="stringliteral">&quot;\nAdded&quot;</span> );
<a name="l00082"></a>00082 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KRemovedMsg, <span class="stringliteral">&quot;\nRemoved&quot;</span> );
<a name="l00083"></a>00083 _LIT8( KChars8, <span class="stringliteral">&quot;abcdefghijklmnopqrstuvwxyz0123456789&quot;</span> );
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00086"></a>00086 <span class="comment">// This example method is documented in header file &quot;DescriptorExamples.h&quot;</span>
<a name="l00087"></a>00087 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00088"></a><a class="code" href="class_c_descriptor_examples.html#a16794acec84adb6c9f9bd53493bfda8f">00088</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_examples.html#a16794acec84adb6c9f9bd53493bfda8f">CDescriptorExamples::CircularBuffersL</a>()
<a name="l00089"></a>00089     {
<a name="l00090"></a>00090     TPtr output( iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a30d7e86bbb78ba769648736a9ee9e62d">GetViewBuffer</a>() );
<a name="l00091"></a>00091     RenderHeader( _L( <span class="stringliteral">&quot;CircularBuffers:TText&quot;</span> ), output );
<a name="l00092"></a>00092 
<a name="l00093"></a>00093     <span class="comment">// -------------------------------------------------------------------------</span>
<a name="l00094"></a>00094     <span class="comment">// This first example demonstrates how circular buffers can be used to</span>
<a name="l00095"></a>00095     <span class="comment">// buffer character data.</span>
<a name="l00096"></a>00096     TBuf&lt;10&gt; deletedChars; <span class="comment">// stores characters removed from fifo</span>
<a name="l00097"></a>00097     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KNumbersTxt, <span class="stringliteral">&quot;0123456789&quot;</span> );
<a name="l00098"></a>00098     <span class="comment">// point to first character in character array stored in TLitC</span>
<a name="l00099"></a>00099     TText *charPtr = (TText*)KNumbersTxt().Ptr();
<a name="l00100"></a>00100     CCirBuf&lt;TText&gt; *textFIFO;
<a name="l00101"></a>00101 
<a name="l00102"></a>00102     <span class="comment">// construct fifo able to store up to ten characters:</span>
<a name="l00103"></a>00103     <span class="comment">// contents of fifo is shown below (H=head, T=Tail).</span>
<a name="l00104"></a>00104     <span class="comment">// fifo: data= &quot;__________&quot;, count = 0</span>
<a name="l00105"></a>00105     <span class="comment">//              ^</span>
<a name="l00106"></a>00106     <span class="comment">//             H&amp;T</span>
<a name="l00107"></a>00107     textFIFO = <span class="keyword">new</span> (ELeave) CCirBuf&lt;TText&gt;();
<a name="l00108"></a>00108     CleanupStack::PushL( textFIFO );
<a name="l00109"></a>00109     textFIFO-&gt;SetLengthL( 10 ); <span class="comment">// can store up to ten characters</span>
<a name="l00110"></a>00110 
<a name="l00111"></a>00111     <span class="comment">// Copy first 5 items (characters) to fifo</span>
<a name="l00112"></a>00112     <span class="comment">// fifo: data= &quot;01234_____&quot;, count = 5</span>
<a name="l00113"></a>00113     <span class="comment">//              ^    ^</span>
<a name="l00114"></a>00114     <span class="comment">//              T    H</span>
<a name="l00115"></a>00115     textFIFO-&gt;Add( charPtr, 5 ); <span class="comment">// 01234</span>
<a name="l00116"></a>00116     ShowContents( KAddedMsg, KNumbersTxt().Left(5), output );
<a name="l00117"></a>00117     ShowContents( textFIFO, output ); <span class="comment">// size=5, max=10</span>
<a name="l00118"></a>00118 
<a name="l00119"></a>00119     <span class="comment">// remove three items from fifo (first three characters) and</span>
<a name="l00120"></a>00120     <span class="comment">// store copies of them to deletedChars buffer.</span>
<a name="l00121"></a>00121     <span class="comment">// fifo: data= &quot;___34_____&quot;, count = 2</span>
<a name="l00122"></a>00122     <span class="comment">//                 ^ ^</span>
<a name="l00123"></a>00123     <span class="comment">//                 T H</span>
<a name="l00124"></a>00124     textFIFO-&gt;Remove( (TText*)deletedChars.Ptr(), 3 ); <span class="comment">// chars &quot;012&quot;</span>
<a name="l00125"></a>00125     deletedChars.SetLength(3);
<a name="l00126"></a>00126     ShowContents( KRemovedMsg, deletedChars, output );
<a name="l00127"></a>00127     ShowContents( textFIFO, output ); <span class="comment">// size=5, max=10</span>
<a name="l00128"></a>00128 
<a name="l00129"></a>00129     <span class="comment">// add 6 characters so the head rounds to the beginning.</span>
<a name="l00130"></a>00130     <span class="comment">// fifo: data= &quot;5__3401234&quot;, count = 8</span>
<a name="l00131"></a>00131     <span class="comment">//               ^ ^</span>
<a name="l00132"></a>00132     <span class="comment">//               H T</span>
<a name="l00133"></a>00133     textFIFO-&gt;Add( charPtr, 6 ); <span class="comment">// 012345</span>
<a name="l00134"></a>00134     ShowContents( KAddedMsg, KNumbersTxt().Left(6), output );
<a name="l00135"></a>00135     ShowContents( textFIFO, output ); <span class="comment">// size=8, max=10</span>
<a name="l00136"></a>00136 
<a name="l00137"></a>00137     <span class="comment">// try to add 4 characters. Since there isn&#39;t enough space</span>
<a name="l00138"></a>00138     <span class="comment">// only two characters are added since no more room available.</span>
<a name="l00139"></a>00139     <span class="comment">// fifo: data= &quot;5013401234&quot;, count = 10</span>
<a name="l00140"></a>00140     <span class="comment">//                 ^</span>
<a name="l00141"></a>00141     <span class="comment">//                H&amp;T</span>
<a name="l00142"></a>00142     TInt charsAdded = textFIFO-&gt;Add( charPtr, 4 ); <span class="comment">// 0123</span>
<a name="l00143"></a>00143     ShowContents( KAddedMsg, KNumbersTxt().Left(4), output );
<a name="l00144"></a>00144     output.AppendFormat( _L(<span class="stringliteral">&quot;But only %d characters was really added\n&quot;</span>),
<a name="l00145"></a>00145                          charsAdded );
<a name="l00146"></a>00146     ShowContents( textFIFO, output ); <span class="comment">// size=10, max=10</span>
<a name="l00147"></a>00147 
<a name="l00148"></a>00148     <span class="comment">// remove eight items from fifo (now tail rounds to beginning)</span>
<a name="l00149"></a>00149     <span class="comment">// fifo: data= &quot;_01_______&quot;, count = 2</span>
<a name="l00150"></a>00150     <span class="comment">//               ^ ^</span>
<a name="l00151"></a>00151     <span class="comment">//               T H</span>
<a name="l00152"></a>00152     textFIFO-&gt;Remove( (TText*)deletedChars.Ptr(), 8 ); <span class="comment">// chars &quot;34012345&quot;</span>
<a name="l00153"></a>00153     deletedChars.SetLength(8);
<a name="l00154"></a>00154     ShowContents( KRemovedMsg, deletedChars, output );
<a name="l00155"></a>00155     ShowContents( textFIFO, output ); <span class="comment">// size=2, max=10</span>
<a name="l00156"></a>00156 
<a name="l00157"></a>00157     <span class="comment">// -------------------------------------------------------------------------</span>
<a name="l00158"></a>00158     <span class="comment">// This example introduces how CCirBuf is used to store complex data types.</span>
<a name="l00159"></a>00159     <span class="comment">// Since CCirBuf is templated its items can be any type.</span>
<a name="l00160"></a>00160     RenderHeader( _L( <span class="stringliteral">&quot;CircularBuffers:TExample&quot;</span> ), output );
<a name="l00161"></a>00161 
<a name="l00162"></a>00162     <span class="comment">// declare pointer to circular buffer (FIFO) that is able</span>
<a name="l00163"></a>00163     <span class="comment">// to store TExample items.</span>
<a name="l00164"></a>00164     CCirBuf&lt;TExample&gt; *exampleFIFO;
<a name="l00165"></a>00165     <span class="comment">// when items are removed one by one, the copy of deleted item</span>
<a name="l00166"></a>00166     <span class="comment">// is copied to this instance</span>
<a name="l00167"></a>00167     TExample removedItem;
<a name="l00168"></a>00168 
<a name="l00169"></a>00169     <span class="comment">// Construct an instance of FIFO that can store up to</span>
<a name="l00170"></a>00170     <span class="comment">// five Example class instances.</span>
<a name="l00171"></a>00171     exampleFIFO = <span class="keyword">new</span> (ELeave) CCirBuf&lt;TExample&gt;();
<a name="l00172"></a>00172     CleanupStack::PushL( exampleFIFO );
<a name="l00173"></a>00173     exampleFIFO-&gt;SetLengthL( 5 );
<a name="l00174"></a>00174 
<a name="l00175"></a>00175     <span class="comment">// Populate FIFO with three items and show contents</span>
<a name="l00176"></a>00176     <span class="comment">// of added item and state of FIFO.</span>
<a name="l00177"></a>00177     TExample one(1, _L(<span class="stringliteral">&quot;one&quot;</span>));
<a name="l00178"></a>00178     exampleFIFO-&gt;Add( &amp;one );
<a name="l00179"></a>00179     ShowContents( KAddedMsg, one, output );
<a name="l00180"></a>00180     ShowContents( exampleFIFO, output ); <span class="comment">// size=1, max=5</span>
<a name="l00181"></a>00181 
<a name="l00182"></a>00182     TExample two(2, _L(<span class="stringliteral">&quot;two&quot;</span>));
<a name="l00183"></a>00183     exampleFIFO-&gt;Add( &amp;two );
<a name="l00184"></a>00184     ShowContents( KAddedMsg, two, output );
<a name="l00185"></a>00185     ShowContents( exampleFIFO, output ); <span class="comment">// size=2, max=5</span>
<a name="l00186"></a>00186 
<a name="l00187"></a>00187     TExample three(3, _L(<span class="stringliteral">&quot;three&quot;</span>));
<a name="l00188"></a>00188     exampleFIFO-&gt;Add( &amp;three );
<a name="l00189"></a>00189     ShowContents( KAddedMsg, three, output );
<a name="l00190"></a>00190     ShowContents( exampleFIFO, output ); <span class="comment">// size=3, max=5</span>
<a name="l00191"></a>00191 
<a name="l00192"></a>00192     <span class="comment">// Remove item by item from FIFO and show contents of</span>
<a name="l00193"></a>00193     <span class="comment">// removed item and the state of FIFO.</span>
<a name="l00194"></a>00194     <span class="comment">// Remove() method takes a pointer to object where contents</span>
<a name="l00195"></a>00195     <span class="comment">// of removed item is copied (binary copy)</span>
<a name="l00196"></a>00196     <span class="keywordflow">while</span>( exampleFIFO-&gt;Count() &gt; 0 )
<a name="l00197"></a>00197         {
<a name="l00198"></a>00198         exampleFIFO-&gt;Remove( &amp;removedItem );
<a name="l00199"></a>00199         ShowContents( KRemovedMsg, removedItem, output );
<a name="l00200"></a>00200         ShowContents( exampleFIFO, output );
<a name="l00201"></a>00201         }
<a name="l00202"></a>00202 
<a name="l00203"></a>00203     iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a8e10673e2504a4af6382f26794bb8004">UpdateView</a>();
<a name="l00204"></a>00204     CleanupStack::PopAndDestroy(2); <span class="comment">// exampleFIFO, textFIFO</span>
<a name="l00205"></a>00205     }
<a name="l00206"></a>00206 
<a name="l00207"></a>00207 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00208"></a>00208 <span class="comment">// This example method is documented in header file &quot;DescriptorExamples.h&quot; and</span>
<a name="l00209"></a>00209 <span class="comment">// implementation specific documentation can be read below.</span>
<a name="l00210"></a>00210 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00211"></a><a class="code" href="class_c_descriptor_examples.html#a7b302d526ed71c8039a1be75d9ceb21a">00211</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_examples.html#a7b302d526ed71c8039a1be75d9ceb21a">CDescriptorExamples::FlatDynamicBuffersL</a>()
<a name="l00212"></a>00212     {
<a name="l00213"></a>00213     TPtr output( iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a30d7e86bbb78ba769648736a9ee9e62d">GetViewBuffer</a>() );
<a name="l00214"></a>00214     RenderHeader( _L( <span class="stringliteral">&quot;FlatDynamicBuffers&quot;</span> ), output );
<a name="l00215"></a>00215 
<a name="l00216"></a>00216     <span class="comment">// -------------------------------------------------------------------------</span>
<a name="l00217"></a>00217     <span class="comment">// When content (8 bit characters) are added to container, it allocates the</span>
<a name="l00218"></a>00218     <span class="comment">// memory automatically. In the first steps it can extend the existing heap</span>
<a name="l00219"></a>00219     <span class="comment">// cell when more space is needed.</span>
<a name="l00220"></a>00220     <span class="comment">//</span>
<a name="l00221"></a>00221     <span class="comment">// However, later in the example a HBufC is allocated from heap to prevent</span>
<a name="l00222"></a>00222     <span class="comment">// heap cell extending. When more data is appended to buffer, a new heap</span>
<a name="l00223"></a>00223     <span class="comment">// cell is allocated from somewhere else, existing content is copied to new</span>
<a name="l00224"></a>00224     <span class="comment">// cell, new content to be appended is added after it and finally the</span>
<a name="l00225"></a>00225     <span class="comment">// existing heap cell is deallocated.</span>
<a name="l00226"></a>00226     <span class="comment">//</span>
<a name="l00227"></a>00227     <span class="comment">// The contents of buffer is shown after each character insertion. The</span>
<a name="l00228"></a>00228     <span class="comment">// location of data (memory address of heap cell) doesn&#39;t change until the</span>
<a name="l00229"></a>00229     <span class="comment">// fourth insertion because heap cell can&#39;t extend anymore.</span>
<a name="l00230"></a>00230 
<a name="l00231"></a>00231     <span class="comment">// construct a flat dynamic buffer that will automatically extend its heap</span>
<a name="l00232"></a>00232     <span class="comment">// cell size with 10 bytes when more space is needed.</span>
<a name="l00233"></a>00233     CBufFlat *buf = CBufFlat::NewL( 10 );
<a name="l00234"></a>00234     CleanupStack::PushL(buf);
<a name="l00235"></a>00235 
<a name="l00236"></a>00236     <span class="comment">// this variable is used to refer a portion of characters in KChars8</span>
<a name="l00237"></a>00237     TPtrC8 charsToInsert(NULL, 0);
<a name="l00238"></a>00238 
<a name="l00239"></a>00239     charsToInsert.Set( KChars8().Mid( 0, 8 ) ); <span class="comment">// &quot;abcdefgh&quot;</span>
<a name="l00240"></a>00240     buf-&gt;InsertL( 0, charsToInsert );
<a name="l00241"></a>00241     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00242"></a>00242     ShowBuf( *buf, output );
<a name="l00243"></a>00243 
<a name="l00244"></a>00244     charsToInsert.Set( KChars8().Mid( 8, 8 ) ); <span class="comment">// &quot;ijklmnop&quot;</span>
<a name="l00245"></a>00245     buf-&gt;InsertL( 8, charsToInsert );
<a name="l00246"></a>00246     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00247"></a>00247     ShowBuf( *buf, output );
<a name="l00248"></a>00248 
<a name="l00249"></a>00249     charsToInsert.Set( KChars8().Mid( 16, 12 ) ); <span class="comment">// &quot;ijklmnop&quot;</span>
<a name="l00250"></a>00250     buf-&gt;InsertL( 16, charsToInsert );
<a name="l00251"></a>00251     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00252"></a>00252     ShowBuf( *buf, output );
<a name="l00253"></a>00253 
<a name="l00254"></a>00254     <span class="comment">// this object is allocated just after the flat dynamic buffers heap</span>
<a name="l00255"></a>00255     <span class="comment">// cell preventing it to extend its cell size when more space is needed.</span>
<a name="l00256"></a>00256     HBufC *tmpBuf = HBufC::NewL( 50 );
<a name="l00257"></a>00257     CleanupStack::PushL( tmpBuf );
<a name="l00258"></a>00258     tmpBuf-&gt;Length(); <span class="comment">// remove compiler warning that variable is not used</span>
<a name="l00259"></a>00259 
<a name="l00260"></a>00260     <span class="comment">// appending this data to buffer requires heap cell to extend.</span>
<a name="l00261"></a>00261     <span class="comment">// tmpBuf prevents heap cell to extend so new cell has to be</span>
<a name="l00262"></a>00262     <span class="comment">// allocated, original data copied to there and existing cell</span>
<a name="l00263"></a>00263     <span class="comment">// to be freed.</span>
<a name="l00264"></a>00264     charsToInsert.Set( KChars8().Mid( 4, 20 ) ); <span class="comment">// &quot;efghijklmnopqrstuvwx&quot;</span>
<a name="l00265"></a>00265     buf-&gt;InsertL(28, charsToInsert );
<a name="l00266"></a>00266     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00267"></a>00267     ShowBuf( *buf, output );
<a name="l00268"></a>00268 
<a name="l00269"></a>00269     iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a8e10673e2504a4af6382f26794bb8004">UpdateView</a>();
<a name="l00270"></a>00270     CleanupStack::PopAndDestroy(2); <span class="comment">// tmpBuf, buf</span>
<a name="l00271"></a>00271     }
<a name="l00272"></a>00272 
<a name="l00273"></a>00273 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00274"></a>00274 <span class="comment">// This example method is documented in header file &quot;DescriptorExamples.h&quot;</span>
<a name="l00275"></a>00275 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00276"></a><a class="code" href="class_c_descriptor_examples.html#a4fbafdaa5db8471d65748de40a0fac1b">00276</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_examples.html#a4fbafdaa5db8471d65748de40a0fac1b">CDescriptorExamples::SegmentedDynamicBuffersL</a>()
<a name="l00277"></a>00277     {
<a name="l00278"></a>00278     TPtr output( iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a30d7e86bbb78ba769648736a9ee9e62d">GetViewBuffer</a>() );
<a name="l00279"></a>00279     RenderHeader( _L( <span class="stringliteral">&quot;SegmentedDynamicBuffers&quot;</span> ), output );
<a name="l00280"></a>00280 
<a name="l00281"></a>00281     <span class="comment">// Allocate a empty buffer with granularity of 10</span>
<a name="l00282"></a>00282     CBufSeg* buf = CBufSeg::NewL(10);
<a name="l00283"></a>00283     CleanupStack::PushL( buf );
<a name="l00284"></a>00284 
<a name="l00285"></a>00285     TPtrC8 charsToInsert(NULL, 0);
<a name="l00286"></a>00286 
<a name="l00287"></a>00287     <span class="comment">// append &quot;abcdefgh&quot;</span>
<a name="l00288"></a>00288     <span class="comment">// All eight characters fit to first segment</span>
<a name="l00289"></a>00289     charsToInsert.Set( KChars8().Mid(0, 8) );
<a name="l00290"></a>00290     buf-&gt;InsertL(0, charsToInsert );
<a name="l00291"></a>00291     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00292"></a>00292     ShowBuf( *buf, output );
<a name="l00293"></a>00293 
<a name="l00294"></a>00294     <span class="comment">// append &quot;ijklmnop&quot;</span>
<a name="l00295"></a>00295     <span class="comment">// first two characters go to the first segment and</span>
<a name="l00296"></a>00296     <span class="comment">// the rest six to second one.</span>
<a name="l00297"></a>00297     charsToInsert.Set( KChars8().Mid(8, 8) );
<a name="l00298"></a>00298     buf-&gt;InsertL(8, charsToInsert );
<a name="l00299"></a>00299     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00300"></a>00300     ShowBuf( *buf, output );
<a name="l00301"></a>00301 
<a name="l00302"></a>00302     <span class="comment">// append &quot;qrstuvwxyz01&quot;</span>
<a name="l00303"></a>00303     <span class="comment">// first four characters go to the second segment and</span>
<a name="l00304"></a>00304     <span class="comment">// the rest eight to third one.</span>
<a name="l00305"></a>00305     charsToInsert.Set( KChars8().Mid(16, 12) );
<a name="l00306"></a>00306     buf-&gt;InsertL(16, charsToInsert );
<a name="l00307"></a>00307     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00308"></a>00308     ShowBuf( *buf, output );
<a name="l00309"></a>00309 
<a name="l00310"></a>00310     <span class="comment">// append &quot;efghijklmnopqrstuvwx&quot;</span>
<a name="l00311"></a>00311     <span class="comment">// first two characters go to the third segment. Next ten to</span>
<a name="l00312"></a>00312     <span class="comment">// fourth segment and rest eight to fifth segment.</span>
<a name="l00313"></a>00313     charsToInsert.Set( KChars8().Mid(4, 20) );
<a name="l00314"></a>00314     buf-&gt;InsertL(28, charsToInsert );
<a name="l00315"></a>00315     ShowContents( KAddedMsg, charsToInsert, output );
<a name="l00316"></a>00316     ShowBuf( *buf, output );
<a name="l00317"></a>00317 
<a name="l00318"></a>00318     <span class="comment">// delete a portion from the segmented buffer.</span>
<a name="l00319"></a>00319     <span class="comment">//</span>
<a name="l00320"></a>00320     <span class="comment">// An exmaple run shows that segments before deletion are</span>
<a name="l00321"></a>00321     <span class="comment">//</span>
<a name="l00322"></a>00322     <span class="comment">// CBufSeg: size=48, segments=</span>
<a name="l00323"></a>00323     <span class="comment">//   &quot;abcdefghij&quot; @13984212</span>
<a name="l00324"></a>00324     <span class="comment">//   &quot;klmnopqrst&quot; @13984248</span>
<a name="l00325"></a>00325     <span class="comment">//   &quot;uvwxyz01ef&quot; @13984284</span>
<a name="l00326"></a>00326     <span class="comment">//   &quot;ghijklmnop&quot; @13984356</span>
<a name="l00327"></a>00327     <span class="comment">//   &quot;qrstuvwx&quot; @13984320</span>
<a name="l00328"></a>00328     <span class="comment">//</span>
<a name="l00329"></a>00329     <span class="comment">// and after deletion there are segments:</span>
<a name="l00330"></a>00330     <span class="comment">//</span>
<a name="l00331"></a>00331     <span class="comment">// CBufSeg: size=24, segments=</span>
<a name="l00332"></a>00332     <span class="comment">//   &quot;abc&quot; @13984212</span>
<a name="l00333"></a>00333     <span class="comment">//   &quot;1ef&quot; @13984284</span>
<a name="l00334"></a>00334     <span class="comment">//   &quot;ghijklmnop&quot; @13984356</span>
<a name="l00335"></a>00335     <span class="comment">//   &quot;qrstuvwx&quot; @13984320</span>
<a name="l00336"></a>00336     <span class="comment">//</span>
<a name="l00337"></a>00337     <span class="comment">// From this example it can be seen that modifying segment</span>
<a name="l00338"></a>00338     <span class="comment">// buffer can result segments not fully filled. That&#39;s why</span>
<a name="l00339"></a>00339     <span class="comment">// direct access thought pointer is difficult since the</span>
<a name="l00340"></a>00340     <span class="comment">// segment sizes varies.</span>
<a name="l00341"></a>00341     buf-&gt;Delete(3, 24);
<a name="l00342"></a>00342     output.Append( _L(<span class="stringliteral">&quot;\nDeleted 24 bytes from index 4\n&quot;</span>) );
<a name="l00343"></a>00343     ShowBuf( *buf, output );
<a name="l00344"></a>00344 
<a name="l00345"></a>00345     <span class="comment">// Replace character at even index with &#39;X&#39;</span>
<a name="l00346"></a>00346     <span class="comment">//</span>
<a name="l00347"></a>00347     <span class="comment">// Since data is splitted to segments that may contain variable</span>
<a name="l00348"></a>00348     <span class="comment">// number of character data it would be quite difficult to alter</span>
<a name="l00349"></a>00349     <span class="comment">// data with pointer access. That&#39;s why the easiest way to alter</span>
<a name="l00350"></a>00350     <span class="comment">// data is to copy it to fixed sized buffer, modify the copy and</span>
<a name="l00351"></a>00351     <span class="comment">// write modified content over original data.</span>
<a name="l00352"></a>00352     <span class="comment">//</span>
<a name="l00353"></a>00353     <span class="comment">// Since the segmented buffer could be quite long in real problem</span>
<a name="l00354"></a>00354     <span class="comment">// it is better to get used to modify the content in pieces.</span>
<a name="l00355"></a>00355     <span class="comment">//</span>
<a name="l00356"></a>00356     <span class="comment">// Example run produces:</span>
<a name="l00357"></a>00357     <span class="comment">//</span>
<a name="l00358"></a>00358     <span class="comment">// CBufSeg: size=24, segments=</span>
<a name="l00359"></a>00359     <span class="comment">//   &quot;aXc&quot; @13984212</span>
<a name="l00360"></a>00360     <span class="comment">//   &quot;XeX&quot; @13984284</span>
<a name="l00361"></a>00361     <span class="comment">//   &quot;gXiXkXmXoX&quot; @13984356</span>
<a name="l00362"></a>00362     <span class="comment">//   &quot;qXsXuXwX&quot; @13984320</span>
<a name="l00363"></a>00363     <span class="comment">//</span>
<a name="l00364"></a>00364     TBuf8&lt;20&gt; tmpBuf;
<a name="l00365"></a>00365     <span class="keywordflow">for</span>( TInt i=0; i &lt; buf-&gt;Size(); i += tmpBuf.MaxLength() )
<a name="l00366"></a>00366     {
<a name="l00367"></a>00367         TInt charsToCopy = buf-&gt;Size() - i; <span class="comment">// Chars left</span>
<a name="l00368"></a>00368 
<a name="l00369"></a>00369         <span class="comment">// do not try to read more than tmpBuf can hold</span>
<a name="l00370"></a>00370         <span class="keywordflow">if</span>( charsToCopy &gt; tmpBuf.MaxLength() )
<a name="l00371"></a>00371             {
<a name="l00372"></a>00372             charsToCopy = tmpBuf.MaxLength();
<a name="l00373"></a>00373             }
<a name="l00374"></a>00374 
<a name="l00375"></a>00375         <span class="comment">// copy data from segmented buffer to descriptor</span>
<a name="l00376"></a>00376         buf-&gt;Read(i, tmpBuf, charsToCopy);
<a name="l00377"></a>00377 
<a name="l00378"></a>00378         <span class="comment">// Change character in descriptor at even index</span>
<a name="l00379"></a>00379         <span class="keywordflow">for</span>(TInt j=0; j&lt;charsToCopy; j++)
<a name="l00380"></a>00380             {
<a name="l00381"></a>00381             <span class="keywordflow">if</span>( j % 2 != 0 )
<a name="l00382"></a>00382                 {
<a name="l00383"></a>00383                     tmpBuf[j] = <span class="charliteral">&#39;X&#39;</span>;
<a name="l00384"></a>00384                 }
<a name="l00385"></a>00385             }
<a name="l00386"></a>00386 
<a name="l00387"></a>00387         <span class="comment">// write modified content to the same location it was read</span>
<a name="l00388"></a>00388         buf-&gt;Write(i, tmpBuf, charsToCopy);
<a name="l00389"></a>00389     }
<a name="l00390"></a>00390     output.Append( _L(<span class="stringliteral">&quot;\nReplaced characters at even index with &#39;X&#39;\n&quot;</span>) );
<a name="l00391"></a>00391     ShowBuf( *buf, output );
<a name="l00392"></a>00392 
<a name="l00393"></a>00393     <span class="comment">// lets compress the data to minimize heap usage: partially</span>
<a name="l00394"></a>00394     <span class="comment">// filled segments are fullfilled and segments no more</span>
<a name="l00395"></a>00395     <span class="comment">// needed are deallocated.</span>
<a name="l00396"></a>00396     <span class="comment">//</span>
<a name="l00397"></a>00397     <span class="comment">// Example run produces:</span>
<a name="l00398"></a>00398     <span class="comment">//</span>
<a name="l00399"></a>00399     <span class="comment">// CBufSeg: size=24, segments=</span>
<a name="l00400"></a>00400     <span class="comment">//   &quot;aXcXeXgXiX&quot; @13984212</span>
<a name="l00401"></a>00401     <span class="comment">//   &quot;kXmXoXqXsX&quot; @13984356</span>
<a name="l00402"></a>00402     <span class="comment">//   &quot;uXwX&quot; @13984320</span>
<a name="l00403"></a>00403     <span class="comment">//</span>
<a name="l00404"></a>00404     <span class="comment">// (first and second segments were fullfilled. There didn&#39;t</span>
<a name="l00405"></a>00405     <span class="comment">//  exist any data in fourth segment so if was deleted)</span>
<a name="l00406"></a>00406     <span class="comment">//</span>
<a name="l00407"></a>00407     buf-&gt;Compress();
<a name="l00408"></a>00408     output.Append( _L(<span class="stringliteral">&quot;\nCompressed buffer\n&quot;</span>) );
<a name="l00409"></a>00409     ShowBuf( *buf, output );
<a name="l00410"></a>00410 
<a name="l00411"></a>00411     iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a8e10673e2504a4af6382f26794bb8004">UpdateView</a>();
<a name="l00412"></a>00412     CleanupStack::PopAndDestroy(1);
<a name="l00413"></a>00413     }
<a name="l00414"></a>00414 
<a name="l00415"></a>00415 
<a name="l00416"></a>00416 
<a name="l00417"></a>00417 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00418"></a>00418 <span class="comment">// This example method is documented in header file &quot;DescriptorExamples.h&quot;</span>
<a name="l00419"></a>00419 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00420"></a><a class="code" href="class_c_descriptor_examples.html#aa3004492a8d6c9ba4aebeb1b81b1f6a3">00420</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_examples.html#aa3004492a8d6c9ba4aebeb1b81b1f6a3">CDescriptorExamples::PackageBuffers</a>()
<a name="l00421"></a>00421     {
<a name="l00422"></a>00422     TPtr output( iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a30d7e86bbb78ba769648736a9ee9e62d">GetViewBuffer</a>() );
<a name="l00423"></a>00423     <span class="comment">// ------------------------------------------------------------</span>
<a name="l00424"></a>00424     <span class="comment">// This first example demonstrates how package buffer is used to</span>
<a name="l00425"></a>00425     <span class="comment">// pack a value class inside.</span>
<a name="l00426"></a>00426     RenderHeader( _L( <span class="stringliteral">&quot;PackageBuffers:TPckgBuf&quot;</span> ), output );
<a name="l00427"></a>00427 
<a name="l00428"></a>00428     <span class="comment">// construct package buffer that does store one instance of TExample</span>
<a name="l00429"></a>00429     <span class="comment">// instance. The insnce inside is empty since constructor of package</span>
<a name="l00430"></a>00430     <span class="comment">// buffer does call also the constructor of capsulated object</span>
<a name="l00431"></a>00431     <span class="comment">// (constructor of TExample in that case that sets fields to empty).</span>
<a name="l00432"></a>00432     TPckgBuf&lt;TExample&gt; pckgBuf;
<a name="l00433"></a>00433     output.Append( _L(<span class="stringliteral">&quot;\nCreated package buffer that stores an empty (by default) TExample object\n&quot;</span>) );
<a name="l00434"></a>00434 
<a name="l00435"></a>00435     ShowContents( pckgBuf, output );
<a name="l00436"></a>00436 
<a name="l00437"></a>00437     <span class="comment">// modify TExample inside package buffer.</span>
<a name="l00438"></a>00438     <span class="comment">//</span>
<a name="l00439"></a>00439     <span class="comment">// To get access to the instance, operator () is used to get</span>
<a name="l00440"></a>00440     <span class="comment">// reference.</span>
<a name="l00441"></a>00441     TExample &amp;exampleRef = pckgBuf();
<a name="l00442"></a>00442     exampleRef.iNumber = 1234567;
<a name="l00443"></a>00443     output.Append( _L(<span class="stringliteral">&quot;\nModified iNumber of TExample inside package buffer\n&quot;</span>) );
<a name="l00444"></a>00444     ShowContents( pckgBuf, output );
<a name="l00445"></a>00445 
<a name="l00446"></a>00446     <span class="comment">// modify TExample inside package buffer - using existing reference</span>
<a name="l00447"></a>00447     exampleRef.iText.Copy( _L( <span class="stringliteral">&quot;Hello!&quot;</span> ) );
<a name="l00448"></a>00448     output.Append( _L(<span class="stringliteral">&quot;\nModified iText of TExample inside package buffer\n&quot;</span>) );
<a name="l00449"></a>00449     ShowContents( pckgBuf, output );
<a name="l00450"></a>00450 
<a name="l00451"></a>00451     <span class="comment">// ------------------------------------------------------------</span>
<a name="l00452"></a>00452     <span class="comment">// This second example demonstrates how package buffer pointer is</span>
<a name="l00453"></a>00453     <span class="comment">// used to refer contenst of value class somewhere in memory.</span>
<a name="l00454"></a>00454     RenderHeader( _L( <span class="stringliteral">&quot;PackageBuffers:TPckg&quot;</span> ), output );
<a name="l00455"></a>00455 
<a name="l00456"></a>00456     TExample example;
<a name="l00457"></a>00457     TPckg&lt;TExample&gt; pckg( example );
<a name="l00458"></a>00458     output.Append( _L(<span class="stringliteral">&quot;\nCreated package buffer that refers to an empty TExample object\n&quot;</span>) );
<a name="l00459"></a>00459     ShowContents(pckg, output);
<a name="l00460"></a>00460 
<a name="l00461"></a>00461     <span class="comment">// modify contents the example object. Showing contents of package</span>
<a name="l00462"></a>00462     <span class="comment">// buffer reveals that package buffer did refer to our external</span>
<a name="l00463"></a>00463     <span class="comment">// instance.</span>
<a name="l00464"></a>00464     example.iNumber = 12345;
<a name="l00465"></a>00465     example.iText.Copy( _L( <span class="stringliteral">&quot;Hello!&quot;</span> ) );
<a name="l00466"></a>00466     output.Append( _L(<span class="stringliteral">&quot;\nCreated package buffer that refers to an empty TExample object\n&quot;</span>) );
<a name="l00467"></a>00467     ShowContents(pckg, output);
<a name="l00468"></a>00468 
<a name="l00469"></a>00469     iViewer-&gt;<a class="code" href="class_m_result_viewer.html#a8e10673e2504a4af6382f26794bb8004">UpdateView</a>();
<a name="l00470"></a>00470     }
<a name="l00471"></a>00471 
<a name="l00472"></a><a class="code" href="class_c_descriptor_examples.html#a0c138dfa0a2aa25627963b9fee1b63d5">00472</a> <span class="keywordtype">void</span> <a class="code" href="class_c_descriptor_examples.html#a0c138dfa0a2aa25627963b9fee1b63d5">CDescriptorExamples::RBufDemonstrations</a>()
<a name="l00473"></a>00473     {
<a name="l00474"></a>00474     <span class="comment">// RBuf::CreateL demo</span>
<a name="l00475"></a>00475     RBuf modifiableBuf;
<a name="l00476"></a>00476     modifiableBuf.CreateL(12);
<a name="l00477"></a>00477     ASSERT(modifiableBuf.Length()==0);
<a name="l00478"></a>00478     ASSERT(modifiableBuf.MaxLength()==12);
<a name="l00479"></a>00479     modifiableBuf.Close();
<a name="l00480"></a>00480 
<a name="l00481"></a>00481     <span class="comment">// RBuf::CreateMaxL  demo</span>
<a name="l00482"></a>00482     modifiableBuf.CreateMaxL(12);
<a name="l00483"></a>00483     ASSERT(modifiableBuf.Length()==12);
<a name="l00484"></a>00484     ASSERT(modifiableBuf.MaxLength()==12);
<a name="l00485"></a>00485     modifiableBuf.Close();
<a name="l00486"></a>00486 
<a name="l00487"></a>00487     <span class="comment">// RBuf::CreateL passing in a descriptor</span>
<a name="l00488"></a>00488     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KHelloWorld, <span class="stringliteral">&quot;Hello World&quot;</span>);
<a name="l00489"></a>00489     modifiableBuf.CreateL(KHelloWorld());
<a name="l00490"></a>00490     ASSERT(modifiableBuf.Length()==11);
<a name="l00491"></a>00491     ASSERT(modifiableBuf.MaxLength()==11);
<a name="l00492"></a>00492     modifiableBuf.Close();
<a name="l00493"></a>00493 
<a name="l00494"></a>00494     <span class="comment">// RBuf::CreateL passing in a descriptor and a maximum length</span>
<a name="l00495"></a>00495     modifiableBuf.CreateL(KHelloWorld(), 15);
<a name="l00496"></a>00496     ASSERT(modifiableBuf.Length()==11);
<a name="l00497"></a>00497     ASSERT(modifiableBuf.MaxLength()==15);
<a name="l00498"></a>00498     modifiableBuf.Close();
<a name="l00499"></a>00499 
<a name="l00500"></a>00500     <span class="comment">// RBuf::CreateL and ReAllocL &amp; modifiable descriptor base class methods</span>
<a name="l00501"></a>00501     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KHello, <span class="stringliteral">&quot;Hello&quot;</span>);
<a name="l00502"></a>00502     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KWorld, <span class="stringliteral">&quot; World&quot;</span>);
<a name="l00503"></a>00503     modifiableBuf.CreateL(5);
<a name="l00504"></a>00504     modifiableBuf.Copy(KHello());
<a name="l00505"></a>00505     modifiableBuf.CleanupClosePushL(); <span class="comment">// Push onto cleanup stack for leave safety</span>
<a name="l00506"></a>00506     modifiableBuf.ReAllocL(11);
<a name="l00507"></a>00507     modifiableBuf.Append(KWorld);
<a name="l00508"></a>00508     CleanupStack::PopAndDestroy(); <span class="comment">// Calls modifiableBuf.Close()</span>
<a name="l00509"></a>00509 
<a name="l00510"></a>00510     <span class="comment">//RBuf::Assign leaks easily.</span>
<a name="l00511"></a>00511     <span class="comment">//If you have memory allocated in the RBuf and you call Assign it leaks.</span>
<a name="l00512"></a>00512     <span class="comment">//You should always call Close() before calling Assign()</span>
<a name="l00513"></a>00513     <span class="comment">//The same goes with Create functions, if there&#39;s memory allocated it leaks.</span>
<a name="l00514"></a>00514     <span class="comment">//modifiableBuf.CreateL(1);    </span>
<a name="l00515"></a>00515     <span class="comment">//modifiableBuf.Close();</span>
<a name="l00516"></a>00516     HBufC* hBuf = KHello().AllocL();
<a name="l00517"></a>00517     modifiableBuf.Assign(hBuf); <span class="comment">//Take ownership of hBuf memory</span>
<a name="l00518"></a>00518     ASSERT(modifiableBuf.Length()==5);
<a name="l00519"></a>00519     modifiableBuf.Close();
<a name="l00520"></a>00520 
<a name="l00521"></a>00521     <span class="comment">//Assignments demo</span>
<a name="l00522"></a>00522     RBuf myRBuf1;
<a name="l00523"></a>00523     RBuf myRBuf2;
<a name="l00524"></a>00524     HBufC* myHBufC = HBufC::NewL(20);
<a name="l00525"></a>00525     myRBuf1.Assign(myHBufC); <span class="comment">//Take ownership of heap memory</span>
<a name="l00526"></a>00526     myRBuf2.Assign(myRBuf1); <span class="comment">//Take ownership of another RBuf</span>
<a name="l00527"></a>00527     myRBuf2.Close();
<a name="l00528"></a>00528     
<a name="l00529"></a>00529     <span class="comment">//Assign, ReAllocL and Append</span>
<a name="l00530"></a>00530     TUint16* ptr = <span class="keyword">static_cast&lt;</span>TUint16*<span class="keyword">&gt;</span> (User::AllocL(5*<span class="keyword">sizeof</span>(TText)));    
<a name="l00531"></a>00531     modifiableBuf.Assign(ptr,5);
<a name="l00532"></a>00532     ASSERT(modifiableBuf.Length()==0);
<a name="l00533"></a>00533     modifiableBuf.Copy(KHello()); <span class="comment">//Copying any more would panic</span>
<a name="l00534"></a>00534     <span class="comment">//modifiableBuf.Append(KWorld);//This  would cause a panic</span>
<a name="l00535"></a>00535 
<a name="l00536"></a>00536     modifiableBuf.CleanupClosePushL(); <span class="comment">//Push onto cleanup stack for leave safety</span>
<a name="l00537"></a>00537     modifiableBuf.ReAllocL(12);
<a name="l00538"></a>00538     modifiableBuf.Append(KWorld);
<a name="l00539"></a>00539     CleanupStack::PopAndDestroy(); <span class="comment">//Calls modifiableBuf.Close() </span>
<a name="l00540"></a>00540     }
<a name="l00541"></a>00541 
<a name="l00542"></a>00542 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00543"></a>00543 <span class="comment">// Implementation of the example class</span>
<a name="l00544"></a>00544 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00545"></a>00545 TExample::TExample(TInt aNumber, <span class="keyword">const</span> TDesC &amp;aText)
<a name="l00546"></a>00546     {
<a name="l00547"></a>00547         iNumber = aNumber;
<a name="l00548"></a>00548         iText.Copy(aText.Left( iText.MaxLength() ) );
<a name="l00549"></a>00549     }
<a name="l00550"></a>00550 
<a name="l00551"></a>00551 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00552"></a>00552 <span class="comment">// Implementation of the helper functions</span>
<a name="l00553"></a>00553 <span class="comment">// -----------------------------------------------------------------------------</span>
<a name="l00554"></a>00554 LOCAL_C <span class="keywordtype">void</span> ShowContents(<span class="keyword">const</span> TDesC&amp; aMsg,
<a name="l00555"></a>00555                           <span class="keyword">const</span> TExample aExample,
<a name="l00556"></a>00556                           TPtr &amp;aOutput)
<a name="l00557"></a>00557     {
<a name="l00558"></a>00558     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KFormat, <span class="stringliteral">&quot;%S: %d, \&quot;%S\&quot;\n&quot;</span> );
<a name="l00559"></a>00559     aOutput.AppendFormat( KFormat, &amp;aMsg, aExample.iNumber, &amp;aExample.iText );
<a name="l00560"></a>00560     }
<a name="l00561"></a>00561 
<a name="l00562"></a>00562 LOCAL_C <span class="keywordtype">void</span> ShowContents(<span class="keyword">const</span> TDesC&amp; aMsg, <span class="keyword">const</span> TDesC &amp;aTxt, TPtr &amp;aOutput)
<a name="l00563"></a>00563     {
<a name="l00564"></a>00564     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KFormat, <span class="stringliteral">&quot;%S: \&quot;%S\&quot;\n&quot;</span> );
<a name="l00565"></a>00565     aOutput.AppendFormat( KFormat, &amp;aMsg, &amp;aTxt );
<a name="l00566"></a>00566     }
<a name="l00567"></a>00567 
<a name="l00568"></a>00568 LOCAL_C <span class="keywordtype">void</span> ShowContents(<span class="keyword">const</span> TDesC&amp; aMsg, <span class="keyword">const</span> TDesC8 &amp;aTxt, TPtr &amp;aOutput)
<a name="l00569"></a>00569     {
<a name="l00570"></a>00570     TBuf&lt;128&gt; buf;
<a name="l00571"></a>00571     buf.Copy(aTxt.Left(buf.MaxLength()));
<a name="l00572"></a>00572     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KFormat, <span class="stringliteral">&quot;%S: \&quot;%S\&quot;\n&quot;</span> );
<a name="l00573"></a>00573     aOutput.AppendFormat( KFormat, &amp;aMsg, &amp;buf );
<a name="l00574"></a>00574     }
<a name="l00575"></a>00575 
<a name="l00576"></a>00576 <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;
<a name="l00577"></a>00577 LOCAL_C <span class="keywordtype">void</span> ShowContents(CCirBuf&lt;T&gt; *aFIFO, TPtr &amp;aOutput)
<a name="l00578"></a>00578     {
<a name="l00579"></a>00579     <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>( KFIFOFormat, <span class="stringliteral">&quot;fifo: size=%d, max=%d\n&quot;</span> );
<a name="l00580"></a>00580     aOutput.AppendFormat( KFIFOFormat, aFIFO-&gt;Count(), aFIFO-&gt;Length() );
<a name="l00581"></a>00581     }
<a name="l00582"></a>00582 
<a name="l00583"></a>00583 LOCAL_C <span class="keywordtype">void</span> ShowBuf(CBufFlat &amp;aBuf, TDes &amp;aOutput)
<a name="l00584"></a>00584     {
<a name="l00585"></a>00585     TPtrC8 data = aBuf.Ptr(0);
<a name="l00586"></a>00586     aOutput.AppendFormat( _L(<span class="stringliteral">&quot;CBufFlat: size=%d, data @%d=\n\&quot;&quot;</span>), aBuf.Size(), data.Ptr() );
<a name="l00587"></a>00587     Append(data, aOutput);
<a name="l00588"></a>00588     aOutput.Append(_L(<span class="stringliteral">&quot;\&quot;\n&quot;</span>));
<a name="l00589"></a>00589     }
<a name="l00590"></a>00590 
<a name="l00591"></a>00591 LOCAL_C <span class="keywordtype">void</span> ShowBuf(CBufSeg &amp;aBuf, TDes &amp;aOutput)
<a name="l00592"></a>00592     {
<a name="l00593"></a>00593     aOutput.AppendFormat( _L(<span class="stringliteral">&quot;CBufSeg: size=%d, segments=\n&quot;</span>), aBuf.Size() );
<a name="l00594"></a>00594     TInt pos = 0;
<a name="l00595"></a>00595     <span class="keywordflow">while</span>( pos &lt; aBuf.Size() )
<a name="l00596"></a>00596         {
<a name="l00597"></a>00597         TPtrC8 ptr = aBuf.Ptr(pos);
<a name="l00598"></a>00598         aOutput.Append( _L(<span class="stringliteral">&quot;  \&quot;&quot;</span>) );
<a name="l00599"></a>00599         Append(ptr, aOutput);
<a name="l00600"></a>00600         aOutput.AppendFormat( _L(<span class="stringliteral">&quot;\&quot; @%d\n&quot;</span>), ptr.Ptr() );
<a name="l00601"></a>00601         pos += ptr.Length();
<a name="l00602"></a>00602         }
<a name="l00603"></a>00603     }
<a name="l00604"></a>00604 
<a name="l00605"></a>00605 LOCAL_C <span class="keywordtype">void</span> ShowContents(TPckgBuf&lt;TExample&gt; &amp;aPackageBuf, TPtr &amp;aOutput)
<a name="l00606"></a>00606     {
<a name="l00607"></a>00607     aOutput.AppendFormat( _L( <span class="stringliteral">&quot;TPckgBuf @%d, sizeof=%d, storing\n  TExample @%d, sizeof=%d, iNumber=%d, iText=\&quot;%S\&quot;\n&quot;</span> ),
<a name="l00608"></a>00608         &amp;aPackageBuf, <span class="keyword">sizeof</span>(aPackageBuf), &amp;aPackageBuf(), <span class="keyword">sizeof</span>(aPackageBuf()), aPackageBuf().iNumber, &amp;aPackageBuf().iText );
<a name="l00609"></a>00609     }
<a name="l00610"></a>00610 
<a name="l00611"></a>00611 LOCAL_C <span class="keywordtype">void</span> ShowContents(TPckg&lt;TExample&gt; &amp;aPackage, TPtr &amp;aOutput)
<a name="l00612"></a>00612     {
<a name="l00613"></a>00613     aOutput.AppendFormat( _L( <span class="stringliteral">&quot;TPckg @%d, sizeof=%d, referring to\n  TExample @%d, sizeof=%d, iNumber=%d, iText=\&quot;%S\&quot;\n&quot;</span> ),
<a name="l00614"></a>00614         &amp;aPackage, <span class="keyword">sizeof</span>(aPackage), &amp;aPackage(), <span class="keyword">sizeof</span>(aPackage()), aPackage().iNumber, &amp;aPackage().iText );
<a name="l00615"></a>00615     }
<a name="l00616"></a>00616 
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>