Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_t_l_s1dll_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/Base/ThreadsAndProcesses/TLS1/TLS1dll.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/ThreadsAndProcesses/TLS1/TLS1dll.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>
<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 &quot;Eclipse Public License v1.0&quot;</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 &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</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">// DLL example program (1) to demonstrate Thread Local Storage (TLS).</span>
<a name="l00015"></a>00015 <span class="comment">// This DLL implements the two classes CSetter and CGeneral</span>
<a name="l00016"></a>00016 <span class="comment">// CSetter is used to set up the static text string, delete it, change it and display</span>
<a name="l00017"></a>00017 <span class="comment">// its content.</span>
<a name="l00018"></a>00018 <span class="comment">// CGeneral can show the content.</span>
<a name="l00019"></a>00019 <span class="comment">// The point being made here is that the text string is, effectively, static writeable data.</span>
<a name="l00020"></a>00020 <span class="comment">// It is accessible by all classes implemented in the DLL.</span>
<a name="l00021"></a>00021 <span class="comment">// CSetter is the only class which sets the static data in this example but, in general,</span>
<a name="l00022"></a>00022 <span class="comment">// any class implemented in the DLL can change/delete/fetch the data</span>
<a name="l00023"></a>00023 <span class="comment">// through the pointer in thread local storage - it is a matter of application design.</span>
<a name="l00024"></a>00024 <span class="comment">//</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="preprocessor">#include &quot;TLS1dll.h&quot;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;e32uid.h&gt;</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxt1,<span class="stringliteral">&quot;&lt;&gt;\n&quot;</span>);
<a name="l00031"></a>00031 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KFormat1,<span class="stringliteral">&quot;&lt;%S&gt;\n&quot;</span>);
<a name="l00032"></a>00032 
<a name="l00034"></a>00034 <span class="comment">//</span>
<a name="l00035"></a>00035 <span class="comment">// Class CSetter implementation</span>
<a name="l00036"></a>00036 <span class="comment">//</span>
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039         <span class="comment">// C++ constructor sets reference to the console in the</span>
<a name="l00040"></a>00040         <span class="comment">// initializer list.</span>
<a name="l00041"></a>00041     <span class="comment">// Body of constructor is empty.</span>
<a name="l00042"></a>00042     <span class="comment">// Constructor is exported because it is non-trivial</span>
<a name="l00043"></a>00043 EXPORT_C CSetter::CSetter(CConsoleBase&amp; aConsole)
<a name="l00044"></a>00044         : iConsole(aConsole)
<a name="l00045"></a>00045         {
<a name="l00046"></a>00046         }
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 
<a name="l00049"></a>00049         <span class="comment">// Destructor, deletes the static string</span>
<a name="l00050"></a>00050 CSetter::~CSetter()
<a name="l00051"></a>00051         {
<a name="l00052"></a>00052         <span class="keyword">delete</span> (HBufC*)Dll::Tls();
<a name="l00053"></a>00053         Dll::SetTls(NULL);
<a name="l00054"></a>00054         }
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 
<a name="l00057"></a>00057         <span class="comment">// Delete any existing static string; allocates a new HBufC</span>
<a name="l00058"></a>00058         <span class="comment">// and sets thread local storage to point to the HBufC.</span>
<a name="l00059"></a>00059 EXPORT_C <span class="keywordtype">void</span> CSetter::SetStaticTextL(<span class="keyword">const</span> TDesC&amp; aString)
<a name="l00060"></a>00060         {
<a name="l00061"></a>00061         <span class="keyword">delete</span> (HBufC*)Dll::Tls();
<a name="l00062"></a>00062         HBufC* pD = aString.AllocL();
<a name="l00063"></a>00063         Dll::SetTls(pD);
<a name="l00064"></a>00064         }
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 
<a name="l00067"></a>00067         <span class="comment">// Show static text</span>
<a name="l00068"></a>00068 EXPORT_C <span class="keywordtype">void</span>  CSetter::ShowStaticText()<span class="keyword"> const</span>
<a name="l00069"></a>00069 <span class="keyword">        </span>{
<a name="l00070"></a>00070         TDesC* text = ((TDesC*)Dll::Tls());
<a name="l00071"></a>00071         
<a name="l00072"></a>00072         <span class="keywordflow">if</span> (text)
<a name="l00073"></a>00073                 iConsole.Printf(KFormat1, text);
<a name="l00074"></a>00074         <span class="keywordflow">else</span>
<a name="l00075"></a>00075                 iConsole.Printf(KTxt1);
<a name="l00076"></a>00076         }
<a name="l00077"></a>00077 
<a name="l00078"></a>00078 
<a name="l00079"></a>00079 
<a name="l00081"></a>00081 <span class="comment">//</span>
<a name="l00082"></a>00082 <span class="comment">// Class CGeneral implementation</span>
<a name="l00083"></a>00083 <span class="comment">//</span>
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086         <span class="comment">// C++ constructor sets refrence to the console in the</span>
<a name="l00087"></a>00087         <span class="comment">// initializer list.</span>
<a name="l00088"></a>00088     <span class="comment">// Body of constructor is empty.</span>
<a name="l00089"></a>00089     <span class="comment">// Constructor is exported because it is non-trivial</span>
<a name="l00090"></a>00090 EXPORT_C CGeneral::CGeneral(CConsoleBase&amp; aConsole)
<a name="l00091"></a>00091         : iConsole(aConsole)
<a name="l00092"></a>00092         {
<a name="l00093"></a>00093         }
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 
<a name="l00096"></a>00096         <span class="comment">// Show static text</span>
<a name="l00097"></a>00097 EXPORT_C <span class="keywordtype">void</span>  CGeneral::ShowStaticText()<span class="keyword"> const</span>
<a name="l00098"></a>00098 <span class="keyword">        </span>{
<a name="l00099"></a>00099         TDesC* text = ((TDesC*)Dll::Tls());
<a name="l00100"></a>00100         
<a name="l00101"></a>00101         <span class="keywordflow">if</span> (text)
<a name="l00102"></a>00102                 iConsole.Printf(KFormat1, text);
<a name="l00103"></a>00103         <span class="keywordflow">else</span>
<a name="l00104"></a>00104                 iConsole.Printf(KTxt1);
<a name="l00105"></a>00105         }
<a name="l00106"></a>00106 
<a name="l00107"></a>00107 
</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>