Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_complex_server_8h_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/ClientServer/Complex/ComplexServer.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/ClientServer/Complex/ComplexServer.h</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 "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">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="preprocessor">#if !defined(__ComplexServer_H__)</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define __ComplexServer_H__</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span>
<a name="l00019"></a>00019 <span class="comment">//needed for creating server thread.</span>
<a name="l00020"></a>00020 <span class="keyword">const</span> TUint <a class="code" href="secureserver_8h.html#abccd7aceb4760cddd96866248e305f29">KDefaultHeapSize</a>=0x10000;
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// panic reasons</span>
<a name="l00023"></a>00023 <span class="keyword">enum</span> TCountServPanic
<a name="l00024"></a>00024 {
<a name="l00025"></a>00025 <a class="code" href="secureserver_8h.html#a091a5ad2956fb84c4470a59010a0d4efaeef6b7f2a8413e6863e2136b93228c3a">EBadRequest</a> = 1,
<a name="l00026"></a>00026 EBadDescriptor,
<a name="l00027"></a>00027 <a class="code" href="secureserver_8h.html#a091a5ad2956fb84c4470a59010a0d4efa59f7e1b1a0e300077050b023b97ebcfb">EDescriptorNonNumeric</a>,
<a name="l00028"></a>00028 <a class="code" href="secureserver_8h.html#a091a5ad2956fb84c4470a59010a0d4efa4dc32eda4a06b69469187275e825d99f">EMainSchedulerError</a>,
<a name="l00029"></a>00029 ESvrCreateServer,
<a name="l00030"></a>00030 ESvrStartServer,
<a name="l00031"></a>00031 <a class="code" href="secureserver_8h.html#a091a5ad2956fb84c4470a59010a0d4efa36f3ebda4e94aedb5817599162216e69">ECreateTrapCleanup</a>,
<a name="l00032"></a>00032 EBadCounterRemove,
<a name="l00033"></a>00033 <a class="code" href="secureserver_8h.html#a091a5ad2956fb84c4470a59010a0d4efaeebad163989c978b8edd91b6893411c0">EBadSubsessionHandle</a>
<a name="l00034"></a>00034 };
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">/*</span>
<a name="l00040"></a>00040 <span class="comment">CCountServer class</span>
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">Represents the server.</span>
<a name="l00043"></a>00043 <span class="comment"> </span>
<a name="l00044"></a>00044 <span class="comment">The server starts with the first client connect call.</span>
<a name="l00045"></a>00045 <span class="comment">Start includes setting up active scheduler, the server active object,</span>
<a name="l00046"></a>00046 <span class="comment">and the object container index which produces object object containers for each session.</span>
<a name="l00047"></a>00047 <span class="comment">*/</span>
<a name="l00048"></a>00048 <span class="keyword">class </span>CCountServer : <span class="keyword">public</span> CServer2
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">// Creates a new session with the server; the function</span>
<a name="l00054"></a>00054 <span class="comment">// implements the pure virtutal function </span>
<a name="l00055"></a>00055 <span class="comment">// defined in class CServer2</span>
<a name="l00056"></a>00056 CSession2* NewSessionL(<span class="keyword">const</span> TVersion &aVersion,<span class="keyword">const</span> RMessage2& aMessage) <span class="keyword">const</span>;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00059"></a>00059 <span class="comment">// Creats a new server object</span>
<a name="l00060"></a>00060 <span class="keyword">static</span> CCountServer* NewL(CActive::TPriority aActiveObjectPriority);
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="comment">// The thread function executed by the server </span>
<a name="l00063"></a>00063 <span class="keyword">static</span> TInt <a class="code" href="_msg_q_client_8c.html#aa6c400c3d8dbbba550d14cc697133e96">ThreadFunction</a>(TAny* aStarted);
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="comment">// utility function to panic the server.</span>
<a name="l00066"></a>00066 <span class="keyword">static</span> <span class="keywordtype">void</span> PanicServer(TCountServPanic aPanic);
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">public</span> :
<a name="l00069"></a>00069 <span class="comment">// Constructor</span>
<a name="l00070"></a>00070 CCountServer(CActive::TPriority aActiveObjectPriority);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">// Second phase constructor</span>
<a name="l00073"></a>00073 <span class="keywordtype">void</span> ConstructL();
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Returns an object container, and guaranteed </span>
<a name="l00076"></a>00076 <span class="comment">// to produce object containers with unique</span>
<a name="l00077"></a>00077 <span class="comment">// ids within the server.</span>
<a name="l00078"></a>00078 <span class="comment">// Called by a new session to create a container </span>
<a name="l00079"></a>00079 CObjectCon* NewContainerL();
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="comment">// Removes container from the container list</span>
<a name="l00082"></a>00082 <span class="keywordtype">void</span> RemoveContainer(CObjectCon *aCon);
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">// Destructor; exists to do some tidying up.</span>
<a name="l00085"></a>00085 ~CCountServer();
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keyword">private</span>:
<a name="l00088"></a>00088 <span class="comment">// The server has an object container index that</span>
<a name="l00089"></a>00089 <span class="comment">// creates an object container for each session.</span>
<a name="l00090"></a>00090 CObjectConIx* iContainerIndex;
<a name="l00091"></a>00091 };
<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">/*</span>
<a name="l00097"></a>00097 <span class="comment">CCountSession class</span>
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">Represents a session with the server.</span>
<a name="l00100"></a>00100 <span class="comment"> </span>
<a name="l00101"></a>00101 <span class="comment">Functions are provided to respond appropriately to client messages.</span>
<a name="l00102"></a>00102 <span class="comment">A session can own any number of subsession objects.</span>
<a name="l00103"></a>00103 <span class="comment">*/</span>
<a name="l00104"></a>00104 <span class="keyword">class </span>CCountSubSession;
<a name="l00105"></a>00105 <span class="keyword">class </span>CCountSession : <span class="keyword">public</span> CSession2
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keyword">public</span>:
<a name="l00108"></a>00108 <span class="comment">// Create the session</span>
<a name="l00109"></a>00109 <span class="keyword">static</span> CCountSession* NewL();
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keyword">public</span>:
<a name="l00112"></a>00112 <span class="comment">// Constructor</span>
<a name="l00113"></a>00113 CCountSession();
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="comment">// Called by client/server framework after </span>
<a name="l00116"></a>00116 <span class="comment">// session has been successfully created</span>
<a name="l00117"></a>00117 <span class="keywordtype">void</span> CreateL();
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="comment">// Service request</span>
<a name="l00120"></a>00120 <span class="keywordtype">void</span> ServiceL(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00121"></a>00121 <span class="keywordtype">void</span> DispatchMessageL(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">// Creates new subsession</span>
<a name="l00124"></a>00124 <span class="keywordtype">void</span> NewCounterL(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">// Closes the session</span>
<a name="l00127"></a>00127 <span class="keywordtype">void</span> CloseSession();
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">// Gets the number of resources (i.e. CCountSubSession objects)</span>
<a name="l00130"></a>00130 <span class="keywordtype">void</span> NumResourcesL(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// Utility to return the CCountSubSession (subsession) object</span>
<a name="l00133"></a>00133 CCountSubSession* CounterFromHandle(<span class="keyword">const</span> RMessage2& aMessage,TInt aHandle);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="comment">// Delete the subsession object through its handle.</span>
<a name="l00136"></a>00136 <span class="keywordtype">void</span> DeleteCounter(TInt aHandle);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">// Gets the number of server-side subsession objects.</span>
<a name="l00139"></a>00139 TInt CountResources();
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">// Panics client</span>
<a name="l00142"></a>00142 <span class="keywordtype">void</span> PanicClient(<span class="keyword">const</span> RMessage2& aMessage,TInt aPanic) <span class="keyword">const</span>;
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keyword">private</span>:
<a name="l00145"></a>00145 <span class="comment">// Object container for this session.</span>
<a name="l00146"></a>00146 CObjectCon *iContainer;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">// Object index which stores objects</span>
<a name="l00149"></a>00149 <span class="comment">// (CCountSubSession instances) for this session.</span>
<a name="l00150"></a>00150 CObjectIx* iCountersObjectIndex;
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="comment">// Total number of resources. In this example</span>
<a name="l00153"></a>00153 <span class="comment">// a resource is just the number of CCountSubSession objects.</span>
<a name="l00154"></a>00154 TInt iResourceCount;
<a name="l00155"></a>00155 };
<a name="l00156"></a>00156
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="comment">/*</span>
<a name="l00161"></a>00161 <span class="comment">CCountSubSession class</span>
<a name="l00162"></a>00162 <span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">Represents a subsession of CCountSession.</span>
<a name="l00164"></a>00164 <span class="comment">*/</span>
<a name="l00165"></a>00165 <span class="keyword">class </span>CCountSubSession : <span class="keyword">public</span> CObject
<a name="l00166"></a>00166 {
<a name="l00167"></a>00167 <span class="keyword">public</span>:
<a name="l00168"></a>00168 <span class="comment">// creates a new CCountSubSession object.</span>
<a name="l00169"></a>00169 <span class="keyword">static</span> CCountSubSession* NewL(CCountSession* aSession);
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keyword">public</span>:
<a name="l00172"></a>00172 CCountSubSession(CCountSession* aSession);
<a name="l00173"></a>00173 <span class="keywordtype">void</span> ConstructL(CCountSession* aSession);
<a name="l00174"></a>00174 <span class="keywordtype">void</span> SetFromStringL(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00175"></a>00175 <span class="keywordtype">void</span> Increase();
<a name="l00176"></a>00176 <span class="keywordtype">void</span> IncreaseBy(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00177"></a>00177 <span class="keywordtype">void</span> Decrease();
<a name="l00178"></a>00178 <span class="keywordtype">void</span> DecreaseBy(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00179"></a>00179 <span class="keywordtype">void</span> Reset();
<a name="l00180"></a>00180 <span class="keywordtype">void</span> CounterValueL(<span class="keyword">const</span> RMessage2& aMessage);
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="keyword">protected</span>:
<a name="l00183"></a>00183 <span class="comment">// The session that owns this CCountSubSession object.</span>
<a name="l00184"></a>00184 CCountSession* iSession;
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="keyword">private</span>:
<a name="l00187"></a>00187 <span class="comment">// The counter value</span>
<a name="l00188"></a>00188 TInt iCount;
<a name="l00189"></a>00189 };
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="preprocessor">#endif</span>
</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>