Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/secureclientandserver_8h_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/IPC/secureserver/secureclientandserver.h 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/secureserver/secureclientandserver.h</h1><a href="secureclientandserver_8h.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 &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">// Defines enums and constants that are common to the client and the server.</span>
<a name="l00015"></a>00015 <span class="comment">// The most important items are:</span>
<a name="l00016"></a>00016 <span class="comment">// - the enum TSecureServerRequest that defines requests. These request numbers are also known as ‘op codes’.</span>
<a name="l00017"></a>00017 <span class="comment">// - the numbers that define the version of the server and the version of the server that the client requires.</span>
<a name="l00018"></a>00018 <span class="comment">//</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef __SECURECLIENTANDSERVER_H__</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define __SECURECLIENTANDSERVER_H__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;e32base.h&gt;</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;e32cons.h&gt;</span>
<a name="l00032"></a>00032 
<a name="l00036"></a>00036 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KSecureServerName,<span class="stringliteral">&quot;SecureServer&quot;</span>);
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="keyword">const</span> TUint KDefaultMessageSlots=4;
<a name="l00039"></a>00039 
<a name="l00043"></a><a class="code" href="secureclientandserver_8h.html#a2c7a31de3ef992e8aa4c26453c32fc5f">00043</a> <span class="keyword">const</span> TUint <a class="code" href="secureclientandserver_8h.html#a2c7a31de3ef992e8aa4c26453c32fc5f">KSecureServMajorVersionNumber</a> = 0;
<a name="l00044"></a>00044 <span class="keyword">const</span> TUint KSecureServMinorVersionNumber = 1;
<a name="l00045"></a>00045 <span class="keyword">const</span> TUint KSecureServBuildVersionNumber = 1;
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 IMPORT_C TInt StartThread(RThread&amp; aServerThread);
<a name="l00048"></a>00048 
<a name="l00052"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2">00052</a> <span class="keyword">enum</span> <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2">TSecureServerRequest</a>
<a name="l00053"></a>00053         {
<a name="l00057"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2aeeea637ffeed72685729b2eb5c0a1d06">00057</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2aeeea637ffeed72685729b2eb5c0a1d06">ESecureServerCreateSubSession</a>,
<a name="l00061"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a019d5723fe668d1d7092919022bb7cd8">00061</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a019d5723fe668d1d7092919022bb7cd8">ESecureServerCloseSubSession</a>,
<a name="l00065"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a340b8bb36e8a83dedc23b33ad454cc41">00065</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a340b8bb36e8a83dedc23b33ad454cc41">ESecureServerInitSubSession</a>,
<a name="l00069"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a8e272085a7b510b91c0e210e46eb687e">00069</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a8e272085a7b510b91c0e210e46eb687e">ESecureServerCloseSession</a>,
<a name="l00073"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2aac8031c2e6141daa00372a90dbea0686">00073</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2aac8031c2e6141daa00372a90dbea0686">ESecureServerValue</a>,
<a name="l00077"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a7fc92e555feb4e8e8cacd2ea4508b4ed">00077</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a7fc92e555feb4e8e8cacd2ea4508b4ed">ESecureServerResourceCount</a>,
<a name="l00081"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a1b3935c0f5f79f45a27de1fa32654e17">00081</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a1b3935c0f5f79f45a27de1fa32654e17">ESecureServerIncrease</a>,
<a name="l00085"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a9c27793f5b6b3beb6aad11d0bf953144">00085</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a9c27793f5b6b3beb6aad11d0bf953144">ESecureServerIncreaseBy</a>,
<a name="l00089"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a42948fe36fdaab2a2d9a4328ea3eedec">00089</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a42948fe36fdaab2a2d9a4328ea3eedec">ESecureServerDecrease</a>,
<a name="l00093"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a0bcce01e7f822786412221374e7a8b76">00093</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a0bcce01e7f822786412221374e7a8b76">ESecureServerDecreaseBy</a>,
<a name="l00097"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2aa9d1e980d9ed0a23782b98761d7e57d7">00097</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2aa9d1e980d9ed0a23782b98761d7e57d7">ESecureServerReset</a>,
<a name="l00101"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a1c7338d8bb93ce1b82088d1282516d3d">00101</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2a1c7338d8bb93ce1b82088d1282516d3d">ESecureServerSaveCounter</a>,
<a name="l00105"></a><a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2af1d352024cd4a379c9dd9406152b9592">00105</a>         <a class="code" href="secureclientandserver_8h.html#a19a3f57ac2d7b8518f6682573ac637c2af1d352024cd4a379c9dd9406152b9592">ESecureServerSetCounterFromFile</a>
<a name="l00106"></a>00106         };
<a name="l00107"></a>00107 
<a name="l00111"></a><a class="code" href="secureclientandserver_8h.html#ac31a03d737c6ab16ba55ceab73d57b71">00111</a> <span class="keyword">enum</span> <a class="code" href="secureclientandserver_8h.html#ac31a03d737c6ab16ba55ceab73d57b71">TSecureServerLeave</a>
<a name="l00112"></a>00112         {
<a name="l00118"></a><a class="code" href="secureclientandserver_8h.html#ac31a03d737c6ab16ba55ceab73d57b71ae3a6b8e17c25d02a3ae9ca7362ba4d0c">00118</a>         <a class="code" href="secureclientandserver_8h.html#ac31a03d737c6ab16ba55ceab73d57b71ae3a6b8e17c25d02a3ae9ca7362ba4d0c">ENonNumericString</a> = 99
<a name="l00119"></a>00119         };
<a name="l00120"></a>00120 
<a name="l00121"></a>00121 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTextConsoleTitle, <span class="stringliteral">&quot;Secure Server Console&quot;</span>);
<a name="l00122"></a>00122 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTextFailed, <span class="stringliteral">&quot; failed, leave code = %d&quot;</span>);
<a name="l00123"></a>00123 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTextPressAnyKey, <span class="stringliteral">&quot; [press any key]\n&quot;</span>);
<a name="l00124"></a>00124 
<a name="l00125"></a>00125 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtTestingCountServer,<span class="stringliteral">&quot;Testing the count server test with 2 client sub sessions; these represent independent counters \n\n&quot;</span>);
<a name="l00126"></a>00126 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtInitCounterAWith,<span class="stringliteral">&quot;\nInitialize counter A with : &quot;</span>);
<a name="l00127"></a>00127 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtInitCounterBWith,<span class="stringliteral">&quot;\nInitialize counter B with : &quot;</span>);
<a name="l00128"></a>00128 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtInitCounterFailed,<span class="stringliteral">&quot;\nSetting the counter from string failed: non-numeric character detected\n&quot;</span>);
<a name="l00129"></a>00129 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtInitCounterSucceeded,<span class="stringliteral">&quot;\nSetting the counter from string succeeded\n&quot;</span>);
<a name="l00130"></a>00130 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtGetCounterAValue,<span class="stringliteral">&quot;Getting counterA value from server: %d \n&quot;</span>);
<a name="l00131"></a>00131 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtGetCounterBValue,<span class="stringliteral">&quot;Getting counterB value from server: %d \n&quot;</span>);
<a name="l00132"></a>00132 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtTransactionId,<span class="stringliteral">&quot;***\nTransaction ID of the session : %d\n***\n&quot;</span>);
<a name="l00133"></a>00133 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KMsgPressAnyKey,<span class="stringliteral">&quot; (press any key to continue)\n&quot;</span>);
<a name="l00134"></a>00134 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtOption,<span class="stringliteral">&quot;\nEnter 1 to initialise from file\n&quot;</span>);
<a name="l00135"></a>00135 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtInitFromFile,<span class="stringliteral">&quot;\nInitialising from file, value = %d\n&quot;</span>);
<a name="l00136"></a>00136 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtTransactionID,<span class="stringliteral">&quot;\nEnter the Transaction ID for the session\n&quot;</span>);
<a name="l00137"></a>00137 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtSaveToFile,<span class="stringliteral">&quot;\nTo save the value of counter A press &#39;a&#39; and for counter B press &#39;b&#39;..\n&quot;</span>);
<a name="l00138"></a>00138 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtSelectCounter,<span class="stringliteral">&quot;\nYou selected counter %c\n&quot;</span>);
<a name="l00139"></a>00139 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtSaveCounter,<span class="stringliteral">&quot;\nSaving Counter Value..\n&quot;</span>);
<a name="l00140"></a>00140 
<a name="l00141"></a>00141 <span class="preprocessor">#endif</span>
</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>