Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_base_2_i_p_c_2_client_server_2_gettingstarted_2transient_2src_2server_8cpp_source.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/Base/IPC/ClientServer/Gettingstarted/transient/src/server.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/Base/IPC/ClientServer/Gettingstarted/transient/src/server.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 "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">// Transient server example - server implementation</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#include "server.h"</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="keyword">inline</span> CShutdown::CShutdown()
<a name="l00020"></a>00020 :CTimer(-1)
<a name="l00021"></a>00021 {CActiveScheduler::Add(<span class="keyword">this</span>);}
<a name="l00022"></a>00022 <span class="keyword">inline</span> <span class="keywordtype">void</span> CShutdown::ConstructL()
<a name="l00023"></a>00023 {CTimer::ConstructL();}
<a name="l00024"></a>00024 <span class="keyword">inline</span> <span class="keywordtype">void</span> CShutdown::Start()
<a name="l00025"></a>00025 {After(KMyShutdownDelay);}
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keyword">inline</span> CMyServer::CMyServer()
<a name="l00028"></a>00028 :CServer2(0,ESharableSessions)
<a name="l00029"></a>00029 {}
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">inline</span> CMySession::CMySession()
<a name="l00032"></a>00032 {}
<a name="l00033"></a>00033 <span class="keyword">inline</span> <a class="code" href="class_c_my_server.html">CMyServer</a>& CMySession::Server()
<a name="l00034"></a>00034 {<span class="keywordflow">return</span> *<span class="keyword">static_cast<</span><a class="code" href="class_c_my_server.html">CMyServer</a>*<span class="keyword">></span>(<span class="keyword">const_cast<</span>CServer2*<span class="keyword">></span>(CSession2::Server()));}
<a name="l00035"></a>00035 <span class="keyword">inline</span> TBool CMySession::ReceivePending()<span class="keyword"> const</span>
<a name="l00036"></a>00036 <span class="keyword"> </span>{<span class="keywordflow">return</span> !iReceiveMsg.IsNull();}
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keywordtype">void</span> CMySession::CreateL()
<a name="l00042"></a>00042 <span class="comment">//</span>
<a name="l00043"></a>00043 <span class="comment">// 2nd phase construct for sessions - called by the CServer framework</span>
<a name="l00044"></a>00044 <span class="comment">//</span>
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 Server().AddSession();
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048
<a name="l00049"></a>00049 CMySession::~CMySession()
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 Server().DropSession();
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="keywordtype">void</span> CMySession::Send(<span class="keyword">const</span> TDesC& aMessage)
<a name="l00055"></a>00055 <span class="comment">//</span>
<a name="l00056"></a>00056 <span class="comment">// Deliver the message to the client, truncating if required</span>
<a name="l00057"></a>00057 <span class="comment">// If the write fails, panic the client, not the sender</span>
<a name="l00058"></a>00058 <span class="comment">//</span>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <span class="keywordflow">if</span> (ReceivePending())
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 TPtrC m(aMessage);
<a name="l00063"></a>00063 <span class="keywordflow">if</span> (iReceiveLen<aMessage.Length())
<a name="l00064"></a>00064 m.Set(m.Left(iReceiveLen));
<a name="l00065"></a>00065 TInt r=iReceiveMsg.Write(0,m);
<a name="l00066"></a>00066 <span class="keywordflow">if</span> (r==KErrNone)
<a name="l00067"></a>00067 iReceiveMsg.Complete(KErrNone);
<a name="l00068"></a>00068 <span class="keywordflow">else</span>
<a name="l00069"></a>00069 PanicClient(iReceiveMsg,EPanicBadDescriptor);
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071 }
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordtype">void</span> CMySession::ServiceL(<span class="keyword">const</span> RMessage2& aMessage)
<a name="l00074"></a>00074 <span class="comment">//</span>
<a name="l00075"></a>00075 <span class="comment">// Handle a client request.</span>
<a name="l00076"></a>00076 <span class="comment">// Leaving is handled by CMyServer::ServiceError() which reports</span>
<a name="l00077"></a>00077 <span class="comment">// the error code to the client</span>
<a name="l00078"></a>00078 <span class="comment">//</span>
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 <span class="keywordflow">switch</span> (aMessage.Function())
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keywordflow">case</span> ESend:
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 TBuf<KMaxMyMessage> message;
<a name="l00085"></a>00085 aMessage.ReadL(0,message);
<a name="l00086"></a>00086 Server().Send(message);
<a name="l00087"></a>00087 aMessage.Complete(KErrNone);
<a name="l00088"></a>00088 <span class="keywordflow">break</span>;
<a name="l00089"></a>00089 }
<a name="l00090"></a>00090 <span class="keywordflow">case</span> EReceive:
<a name="l00091"></a>00091 <span class="keywordflow">if</span> (ReceivePending())
<a name="l00092"></a>00092 PanicClient(aMessage,EPanicAlreadyReceiving);
<a name="l00093"></a>00093 <span class="keywordflow">else</span>
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 iReceiveMsg=aMessage;
<a name="l00096"></a>00096 iReceiveLen=aMessage.Int1();
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098 <span class="keywordflow">break</span>;
<a name="l00099"></a>00099 <span class="keywordflow">case</span> ECancelReceive:
<a name="l00100"></a>00100 <span class="keywordflow">if</span> (ReceivePending())
<a name="l00101"></a>00101 iReceiveMsg.Complete(KErrCancel);
<a name="l00102"></a>00102 aMessage.Complete(KErrNone);
<a name="l00103"></a>00103 <span class="keywordflow">break</span>;
<a name="l00104"></a>00104 <span class="keywordflow">default</span>:
<a name="l00105"></a>00105 PanicClient(aMessage,EPanicIllegalFunction);
<a name="l00106"></a>00106 <span class="keywordflow">break</span>;
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keywordtype">void</span> CMySession::ServiceError(<span class="keyword">const</span> RMessage2& aMessage,TInt aError)
<a name="l00111"></a>00111 <span class="comment">//</span>
<a name="l00112"></a>00112 <span class="comment">// Handle an error from CMySession::ServiceL()</span>
<a name="l00113"></a>00113 <span class="comment">// A bad descriptor error implies a badly programmed client, so panic it;</span>
<a name="l00114"></a>00114 <span class="comment">// otherwise use the default handling (report the error to the client)</span>
<a name="l00115"></a>00115 <span class="comment">//</span>
<a name="l00116"></a>00116 {
<a name="l00117"></a>00117 <span class="keywordflow">if</span> (aError==KErrBadDescriptor)
<a name="l00118"></a>00118 PanicClient(aMessage,EPanicBadDescriptor);
<a name="l00119"></a>00119 CSession2::ServiceError(aMessage,aError);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordtype">void</span> CShutdown::RunL()
<a name="l00123"></a>00123 <span class="comment">//</span>
<a name="l00124"></a>00124 <span class="comment">// Initiate server exit when the timer expires</span>
<a name="l00125"></a>00125 <span class="comment">//</span>
<a name="l00126"></a>00126 {
<a name="l00127"></a>00127 CActiveScheduler::Stop();
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129
<a name="l00130"></a>00130 CServer2* CMyServer::NewLC()
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 <a class="code" href="class_c_my_server.html">CMyServer</a>* <span class="keyword">self</span>=<span class="keyword">new</span>(ELeave) <a class="code" href="class_c_my_server.html">CMyServer</a>;
<a name="l00133"></a>00133 CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00134"></a>00134 <span class="keyword">self</span>->ConstructL();
<a name="l00135"></a>00135 <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="keywordtype">void</span> CMyServer::ConstructL()
<a name="l00139"></a>00139 <span class="comment">//</span>
<a name="l00140"></a>00140 <span class="comment">// 2nd phase construction - ensure the timer and server objects are running</span>
<a name="l00141"></a>00141 <span class="comment">//</span>
<a name="l00142"></a>00142 {
<a name="l00143"></a>00143 StartL(KMyServerName);
<a name="l00144"></a>00144 iShutdown.ConstructL();
<a name="l00145"></a>00145 <span class="comment">// ensure that the server still exits even if the 1st client fails to connect</span>
<a name="l00146"></a>00146 iShutdown.Start();
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00149"></a>00149
<a name="l00150"></a>00150 CSession2* CMyServer::NewSessionL(<span class="keyword">const</span> TVersion&,<span class="keyword">const</span> RMessage2&) const
<a name="l00151"></a>00151 <span class="comment">//</span>
<a name="l00152"></a>00152 <span class="comment">// Cretae a new client session. This should really check the version number.</span>
<a name="l00153"></a>00153 <span class="comment">//</span>
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155 <span class="keywordflow">return</span> <span class="keyword">new</span>(ELeave) <a class="code" href="class_c_my_session.html">CMySession</a>();
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keywordtype">void</span> CMyServer::AddSession()
<a name="l00159"></a>00159 <span class="comment">//</span>
<a name="l00160"></a>00160 <span class="comment">// A new session is being created</span>
<a name="l00161"></a>00161 <span class="comment">// Cancel the shutdown timer if it was running</span>
<a name="l00162"></a>00162 <span class="comment">//</span>
<a name="l00163"></a>00163 {
<a name="l00164"></a>00164 ++iSessionCount;
<a name="l00165"></a>00165 iShutdown.Cancel();
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keywordtype">void</span> CMyServer::DropSession()
<a name="l00169"></a>00169 <span class="comment">//</span>
<a name="l00170"></a>00170 <span class="comment">// A session is being destroyed</span>
<a name="l00171"></a>00171 <span class="comment">// Start the shutdown timer if it is the last session.</span>
<a name="l00172"></a>00172 <span class="comment">//</span>
<a name="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="keywordflow">if</span> (--iSessionCount==0)
<a name="l00175"></a>00175 iShutdown.Start();
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keywordtype">void</span> CMyServer::Send(<span class="keyword">const</span> TDesC& aMessage)
<a name="l00179"></a>00179 <span class="comment">//</span>
<a name="l00180"></a>00180 <span class="comment">// Pass on the signal to all clients</span>
<a name="l00181"></a>00181 <span class="comment">//</span>
<a name="l00182"></a>00182 {
<a name="l00183"></a>00183 iSessionIter.SetToFirst();
<a name="l00184"></a>00184 CSession2* s;
<a name="l00185"></a>00185 <span class="keywordflow">while</span> ((s=iSessionIter++)!=0)
<a name="l00186"></a>00186 <span class="keyword">static_cast<</span><a class="code" href="class_c_my_session.html">CMySession</a>*<span class="keyword">></span>(s)->Send(aMessage);
<a name="l00187"></a>00187 }
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="keywordtype">void</span> PanicClient(<span class="keyword">const</span> RMessagePtr2& aMessage,TMyPanic aPanic)
<a name="l00190"></a>00190 <span class="comment">//</span>
<a name="l00191"></a>00191 <span class="comment">// RMessage::Panic() also completes the message. This is:</span>
<a name="l00192"></a>00192 <span class="comment">// (a) important for efficient cleanup within the kernel</span>
<a name="l00193"></a>00193 <span class="comment">// (b) a problem if the message is completed a second time</span>
<a name="l00194"></a>00194 <span class="comment">//</span>
<a name="l00195"></a>00195 {
<a name="l00196"></a>00196 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KPanic,<span class="stringliteral">"MyServer"</span>);
<a name="l00197"></a>00197 aMessage.Panic(KPanic,aPanic);
<a name="l00198"></a>00198 }
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="keyword">static</span> <span class="keywordtype">void</span> RunServerL()
<a name="l00201"></a>00201 <span class="comment">//</span>
<a name="l00202"></a>00202 <span class="comment">// Perform all server initialisation, in particular creation of the</span>
<a name="l00203"></a>00203 <span class="comment">// scheduler and server and then run the scheduler</span>
<a name="l00204"></a>00204 <span class="comment">//</span>
<a name="l00205"></a>00205 {
<a name="l00206"></a>00206 <span class="comment">// naming the server thread after the server helps to debug panics</span>
<a name="l00207"></a>00207 User::LeaveIfError(RThread::RenameMe(KMyServerName));
<a name="l00208"></a>00208 <span class="comment">//</span>
<a name="l00209"></a>00209 <span class="comment">// create and install the active scheduler we need</span>
<a name="l00210"></a>00210 CActiveScheduler* s=<span class="keyword">new</span>(ELeave) CActiveScheduler;
<a name="l00211"></a>00211 CleanupStack::PushL(s);
<a name="l00212"></a>00212 CActiveScheduler::Install(s);
<a name="l00213"></a>00213 <span class="comment">//</span>
<a name="l00214"></a>00214 <span class="comment">// create the server (leave it on the cleanup stack)</span>
<a name="l00215"></a>00215 CMyServer::NewLC();
<a name="l00216"></a>00216 <span class="comment">//</span>
<a name="l00217"></a>00217 <span class="comment">// Initialisation complete, now signal the client</span>
<a name="l00218"></a>00218 RProcess::Rendezvous(KErrNone);
<a name="l00219"></a>00219 <span class="comment">//</span>
<a name="l00220"></a>00220 <span class="comment">// Ready to run</span>
<a name="l00221"></a>00221 CActiveScheduler::Start();
<a name="l00222"></a>00222 <span class="comment">//</span>
<a name="l00223"></a>00223 <span class="comment">// Cleanup the server and scheduler</span>
<a name="l00224"></a>00224 CleanupStack::PopAndDestroy(2);
<a name="l00225"></a>00225 }
<a name="l00226"></a>00226
<a name="l00227"></a>00227 TInt E32Main()
<a name="l00228"></a>00228 <span class="comment">//</span>
<a name="l00229"></a>00229 <span class="comment">// Server process entry-point</span>
<a name="l00230"></a>00230 <span class="comment">//</span>
<a name="l00231"></a>00231 {
<a name="l00232"></a>00232 __UHEAP_MARK;
<a name="l00233"></a>00233 <span class="comment">//</span>
<a name="l00234"></a>00234 CTrapCleanup* cleanup=CTrapCleanup::New();
<a name="l00235"></a>00235 TInt r=KErrNoMemory;
<a name="l00236"></a>00236 <span class="keywordflow">if</span> (cleanup)
<a name="l00237"></a>00237 {
<a name="l00238"></a>00238 TRAP(r,RunServerL());
<a name="l00239"></a>00239 <span class="keyword">delete</span> cleanup;
<a name="l00240"></a>00240 }
<a name="l00241"></a>00241 <span class="comment">//</span>
<a name="l00242"></a>00242 __UHEAP_MARKEND;
<a name="l00243"></a>00243 <span class="keywordflow">return</span> r;
<a name="l00244"></a>00244 }
</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>