Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/threadclient_8cpp-source.html
week 10 bug fix submission: Bug 1892, Bug 1897, Bug 1319. Also 3 or 4 documents were found to contain code blocks with SFL, which has been fixed. Partial fix for broken links, links to Forum Nokia, and the 'Symbian platform' terminology issues.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/Base/IPC/AdvancedClientServerExample/ThreadClient/src/threadclient.cpp Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/Base/IPC/AdvancedClientServerExample/ThreadClient/src/threadclient.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2007-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">#include "threadclient.h"</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include "threadserver.h"</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include "threadclientserver.h"</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include<e32debug.h></span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#define KMaxServerNameLength 256</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="keyword">static</span> <span class="keyword">const</span> TUid KUidThreadServer = {0x10283039}; <span class="comment">// Thread Server UID</span>
<a name="l00024"></a>00024 <span class="keyword">const</span> TInt KCreateSessionRetryCount = 2; <span class="comment">//CreateSession retry count</span>
<a name="l00025"></a>00025 <span class="keyword">const</span> TInt KServerDefaultMessageSlots = 2; <span class="comment">//default async message slots</span>
<a name="l00026"></a>00026
<a name="l00033"></a>00033 <span class="keyword">static</span> TInt StartServer()
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">const</span> TUidType serverUid(KNullUid,KNullUid,KUidThreadServer);
<a name="l00036"></a>00036 TThreadFunction serverFunc = <a class="code" href="class_c_thread_server.html#cdab1f08c0f860dd83ccacbf26eeaced">CThreadServer::StartThread</a>;
<a name="l00037"></a>00037 RThread server;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">//create a new thread</span>
<a name="l00040"></a>00040 TInt r = server.Create(_L(<span class="stringliteral">""</span>), serverFunc, KThreadServerStackSize,
<a name="l00041"></a>00041 #ifdef SYMBIAN_USE_SEPARATE_HEAPS
<a name="l00042"></a>00042 KThreadServerInitHeapSize, KThreadServerMaxHeapSize,
<a name="l00043"></a>00043 #<span class="keywordflow">else</span>
<a name="l00044"></a>00044 &User::Heap(), <span class="comment">//shared heap is now default</span>
<a name="l00045"></a>00045 #endif
<a name="l00046"></a>00046 NULL,EOwnerProcess);
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keywordflow">if</span> (r!=KErrNone)
<a name="l00049"></a>00049 <span class="keywordflow">return</span> r;
<a name="l00050"></a>00050 TRequestStatus stat;
<a name="l00051"></a>00051 server.Rendezvous(stat);
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keywordflow">if</span> (stat!=KRequestPending)
<a name="l00054"></a>00054 server.Kill(KErrCouldNotConnect); <span class="comment">// abort startup</span>
<a name="l00055"></a>00055 <span class="keywordflow">else</span>
<a name="l00056"></a>00056 server.Resume(); <span class="comment">// logon OK - start the server</span>
<a name="l00057"></a>00057
<a name="l00058"></a>00058 User::WaitForRequest(stat); <span class="comment">// wait for start or death</span>
<a name="l00059"></a>00059 <span class="comment">// The server exit type may be a panic value and a panic value can be zero, which is the same value as KErrNone. </span>
<a name="l00060"></a>00060 <span class="comment">// So, the exit type is tested for a panic before being returned.</span>
<a name="l00061"></a>00061 r=(server.ExitType()==EExitPanic) ? KErrServerTerminated : stat.Int();
<a name="l00062"></a>00062 server.Close();
<a name="l00063"></a>00063 <span class="keywordflow">return</span> r;
<a name="l00064"></a>00064 }
<a name="l00068"></a><a class="code" href="class_r_thread_client.html#fc30d492698d70ffcf1699ed30be41af">00068</a> EXPORT_C TInt <a class="code" href="class_r_thread_client.html#fc30d492698d70ffcf1699ed30be41af">RThreadClient::Connect</a>()
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 TInt retry=KCreateSessionRetryCount;
<a name="l00071"></a>00071 FOREVER
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 <span class="comment">// try to create a session with the server which has KServerDefaultMessageSlots async message slots</span>
<a name="l00074"></a>00074 TInt r=CreateSession(KThreadServerName,
<a name="l00075"></a>00075 TVersion(KThreadServerVersion,
<a name="l00076"></a>00076 KThreadServerMinorVersionNumber,
<a name="l00077"></a>00077 KThreadServerBuildVersionNumber),
<a name="l00078"></a>00078 KServerDefaultMessageSlots);
<a name="l00079"></a>00079 <span class="keywordflow">if</span> (r!=KErrNotFound && r!=KErrServerTerminated)
<a name="l00080"></a>00080 <span class="keywordflow">return</span> r;
<a name="l00081"></a>00081 <span class="keywordflow">if</span> (--retry==0)
<a name="l00082"></a>00082 <span class="keywordflow">return</span> r;
<a name="l00083"></a>00083 r=StartServer();
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (r!=KErrNone && r!=KErrAlreadyExists)
<a name="l00085"></a>00085 <span class="keywordflow">return</span> r;
<a name="l00086"></a>00086 <span class="comment">// 1. r=KErrNone means Server starts up successfully</span>
<a name="l00087"></a>00087 <span class="comment">// 2. r=KErrAlreadyExists means duplicate server was trying to start up </span>
<a name="l00088"></a>00088 <span class="comment">// Note: if there are other functions called before CServer2::StartL() during construction,</span>
<a name="l00089"></a>00089 <span class="comment">// other errors might happen when the duplicate server is trying to start</span>
<a name="l00090"></a>00090 <span class="comment">// therefore, we recommend CServer2::StartL() is the first function in server construction</span>
<a name="l00091"></a>00091 <span class="comment">// see CThreadServer::ConstructL()</span>
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">// NOTE: If users would like to retry start up server after other scenarios happened, e.g. panic,then go </span>
<a name="l00094"></a>00094 <span class="comment">// through the following steps:</span>
<a name="l00095"></a>00095 <span class="comment">// 1. Increase the value of KCreateSessionRetryCount (only start up server once in this example)</span>
<a name="l00096"></a>00096 <span class="comment">// 2. Need another variable, e.g. TExitType, together with error code returned in StartServer()</span>
<a name="l00097"></a>00097 <span class="comment">// to distinguish these scenarios</span>
<a name="l00098"></a>00098 <span class="comment">// 3. modify the third if statement to stop exit when the required scenarios happens.</span>
<a name="l00099"></a>00099 <span class="comment">// </span>
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101 }
<a name="l00106"></a><a class="code" href="class_r_thread_client.html#08a81078c1757ec543c957a2bdc926c0">00106</a> EXPORT_C TInt <a class="code" href="class_r_thread_client.html#08a81078c1757ec543c957a2bdc926c0">RThreadClient::OpenDriver</a>()
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 <span class="keywordflow">return</span> SendReceive(EThreadServerOpenDriver);
<a name="l00109"></a>00109 }
<a name="l00115"></a><a class="code" href="class_r_thread_client.html#236149601a88df1c7b80fd9259454528">00115</a> EXPORT_C <span class="keywordtype">void</span> <a class="code" href="class_r_thread_client.html#236149601a88df1c7b80fd9259454528">RThreadClient::Send</a>(<span class="keyword">const</span> TDesC8& aBuf, TRequestStatus& aStatus)
<a name="l00116"></a>00116 {
<a name="l00117"></a>00117 SendReceive(EThreadServerSendData, TIpcArgs(&aBuf), aStatus);
<a name="l00118"></a>00118 }
<a name="l00122"></a><a class="code" href="class_r_thread_client.html#177b9da53bb469b741c9b5bb1243b7ec">00122</a> EXPORT_C <span class="keywordtype">void</span> <a class="code" href="class_r_thread_client.html#177b9da53bb469b741c9b5bb1243b7ec">RThreadClient::SendCancel</a>()
<a name="l00123"></a>00123 {
<a name="l00124"></a>00124 SendReceive(EThreadServerSendDataCancel);
<a name="l00125"></a>00125 }
<a name="l00130"></a><a class="code" href="class_r_thread_client.html#6d1378569255876c4a4e901328ad02b3">00130</a> EXPORT_C TInt <a class="code" href="class_r_thread_client.html#6d1378569255876c4a4e901328ad02b3">RThreadClient::UnloadDeviceDriver</a>()
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 <span class="keywordflow">return</span> SendReceive(EThreadServerUnloadDeviceDriver);
<a name="l00133"></a>00133 }
<a name="l00138"></a><a class="code" href="class_r_thread_client.html#52eb0c4b09e2f0a7b2f13e91902286b2">00138</a> EXPORT_C TInt <a class="code" href="class_r_thread_client.html#52eb0c4b09e2f0a7b2f13e91902286b2">RThreadClient::LoadDeviceDriver</a>()
<a name="l00139"></a>00139 {
<a name="l00140"></a>00140 <span class="keywordflow">return</span> SendReceive(EThreadServerLoadDeviceDriver);
<a name="l00141"></a>00141 }
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">//EOF</span>
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:56 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>