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-- |
6
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
3 |
<head> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
5 |
<title>TB9.2 Example Applications: examples/S60CppExamples/ClientServerSync/doc/index.html Source File</title> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
8 |
</head> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
9 |
<body> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
10 |
<!-- Generated by Doxygen 1.6.2 --> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
11 |
<h1>examples/S60CppExamples/ClientServerSync/doc/index.html</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <!DOCTYPE HTML PUBLIC <span class="stringliteral">"-//W3C//DTD HTML 4.0 Transitional//EN"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
12 |
<a name="l00002"></a>00002 <html> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
13 |
<a name="l00003"></a>00003 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
14 |
<a name="l00004"></a>00004 <head> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
15 |
<a name="l00005"></a>00005 <meta http-equiv=<span class="stringliteral">"Content-Type"</span> content=<span class="stringliteral">"text/html;charset=iso-8859-1"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
16 |
<a name="l00006"></a>00006 <title>Synchronous Client/Server Example</title> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
17 |
<a name="l00007"></a>00007 <link href=<span class="stringliteral">"style.css"</span> rel=<span class="stringliteral">"stylesheet"</span> type=<span class="stringliteral">"text/css"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
18 |
<a name="l00008"></a>00008 </head> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
19 |
<a name="l00009"></a>00009 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
20 |
<a name="l00010"></a>00010 <table border=<span class="stringliteral">"0"</span> width=<span class="stringliteral">"100%"</span> height=<span class="stringliteral">"8"</span> bgcolor=<span class="stringliteral">"#eeeeee"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
21 |
<a name="l00011"></a>00011 <tr> <td width=<span class="stringliteral">"100%"</span> height=<span class="stringliteral">"1"</span>><b><font size=<span class="stringliteral">"2"</span> color=<span class="stringliteral">"#000000"</span> face=<span class="stringliteral">"Arial, Helvetica, sans-serif"</span>><strong><a name=Top></a> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
22 |
<a name="l00012"></a>00012 S60 5th Edition SDK </strong></font></b><br><i>Example Applications Guide</i></td></tr> </table> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
23 |
<a name="l00013"></a>00013 <!-- Generated by Doxygen 1.4.5 --> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
24 |
<a name="l00014"></a>00014 <div <span class="keyword">class</span>=<span class="stringliteral">"tabs"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
25 |
<a name="l00015"></a>00015 <ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
26 |
<a name="l00016"></a>00016 <li <span class="keywordtype">id</span>=<span class="stringliteral">"current"</span>><a href=<span class="stringliteral">"index.html"</span>><span>Main&nbsp;Page</span></a></li> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
27 |
<a name="l00017"></a>00017 <li><a href=<span class="stringliteral">"annotated.html"</span>><span>Classes</span></a></li> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
28 |
<a name="l00018"></a>00018 <li><a href=<span class="stringliteral">"files.html"</span>><span>Files</span></a></li> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
29 |
<a name="l00019"></a>00019 </ul></div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
30 |
<a name="l00020"></a>00020 <h1>Synchronous Client/Server Example</h1> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
31 |
<a name="l00021"></a>00021 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
32 |
<a name="l00022"></a>00022 <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"index.html#Intro_sec"</span>>1. About <span class="keyword">this</span> Example</a> <br> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
33 |
<a name="l00023"></a>00023 <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"index.html#Arch_sec"</span>>2. Architecture</a> <br> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
34 |
<a name="l00024"></a>00024 <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"index.html#Design_sec"</span>>3. Design and Implementation</a><p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
35 |
<a name="l00025"></a>00025 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
36 |
<a name="l00026"></a>00026 <h2><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Intro_sec"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
37 |
<a name="l00027"></a>00027 1. About <span class="keyword">this</span> Example</a></h2> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
38 |
<a name="l00028"></a>00028 This example demonstrates the architecture of a simple client server application utilising synchronous calls to the server. The server supplies the current time to its clients.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
39 |
<a name="l00029"></a>00029 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
40 |
<a name="l00030"></a>00030 <h3><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Sub11"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
41 |
<a name="l00031"></a>00031 1.1 APIs demonstrated</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
42 |
<a name="l00032"></a>00032 <ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
43 |
<a name="l00033"></a>00033 <li>CServer2</li><li>CSession2</li><li>RMessagePtr2</li><li>RMessage2</li><li>RSessionBase</li></ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
44 |
<a name="l00034"></a>00034 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
45 |
<a name="l00035"></a>00035 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
46 |
<a name="l00036"></a>00036 <h3><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Sub12"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
47 |
<a name="l00037"></a>00037 1.2 Prerequisites</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
48 |
<a name="l00038"></a>00038 This example exists as a complete application, and has the standard Symbian OS application architecture employing the Application, Document, UI, and View classes. The example makes use of several other Symbian OS concepts which the reader should be aware of before attempting to understand <span class="keyword">this</span> example. These are:<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
49 |
<a name="l00039"></a>00039 <ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
50 |
<a name="l00040"></a>00040 <li>Inter process communication, in particular the following topics:<ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
51 |
<a name="l00041"></a>00041 <li>Inter-process communication overview.</li><li>Client/server overview.</li><li>Using client/server.</li></ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
52 |
<a name="l00042"></a>00042 </li></ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
53 |
<a name="l00043"></a>00043 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
54 |
<a name="l00044"></a>00044 <ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
55 |
<a name="l00045"></a>00045 <li>Thread and process management, in particular the following topics:<ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
56 |
<a name="l00046"></a>00046 <li>Thread and process management overview.</li><li>Semaphores overview.</li><li>Threads and processes overview.</li><li>Using semaphores.</li></ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
57 |
<a name="l00047"></a>00047 </li></ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
58 |
<a name="l00048"></a>00048 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
59 |
<a name="l00049"></a>00049 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
60 |
<a name="l00050"></a>00050 <h3><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Sub13"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
61 |
<a name="l00051"></a>00051 1.3 Running <span class="keyword">this</span> example</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
62 |
<a name="l00052"></a>00052 The application initially presents a <span class="keywordflow">default</span> time to the user, as shown in the following screenshot.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
63 |
<a name="l00053"></a>00053 <div align=<span class="stringliteral">"center"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
64 |
<a name="l00054"></a>00054 <img src=<span class="stringliteral">"initial_screen.jpg"</span> alt=<span class="stringliteral">"initial_screen.jpg"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
65 |
<a name="l00055"></a>00055 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
66 |
<a name="l00056"></a>00056 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
67 |
<a name="l00057"></a>00057 The Options menu presents the following choices:<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
68 |
<a name="l00058"></a>00058 <div align=<span class="stringliteral">"center"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
69 |
<a name="l00059"></a>00059 <img src=<span class="stringliteral">"options_menu.jpg"</span> alt=<span class="stringliteral">"options_menu.jpg"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
70 |
<a name="l00060"></a>00060 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
71 |
<a name="l00061"></a>00061 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
72 |
<a name="l00062"></a>00062 <ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
73 |
<a name="l00063"></a>00063 <li>Select <b>Display Time</b> to request a time update from the server.</li><li>Select <b>Exit</b> to exit the application.</li></ul> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
74 |
<a name="l00064"></a>00064 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
75 |
<a name="l00065"></a>00065 On selecting <b>Display Time</b>, the display will be updated, to reflect the server supplied time, as shown in the following screenshot.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
76 |
<a name="l00066"></a>00066 <div align=<span class="stringliteral">"center"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
77 |
<a name="l00067"></a>00067 <img src=<span class="stringliteral">"updated_time.jpg"</span> alt=<span class="stringliteral">"updated_time.jpg"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
78 |
<a name="l00068"></a>00068 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
79 |
<a name="l00069"></a>00069 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
80 |
<a name="l00070"></a>00070 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
81 |
<a name="l00071"></a>00071 <h2><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Arch_sec"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
82 |
<a name="l00072"></a>00072 2. Architecture</a></h2> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
83 |
<a name="l00073"></a>00073 This example exists as a complete application and has the standard Symbian OS application architecture employing the Application, Document, UI, and View classes. The reader should be familiar with <span class="keyword">this</span> architecture before proceeding.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
84 |
<a name="l00074"></a>00074 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
85 |
<a name="l00075"></a>00075 <h2><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Design_sec"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
86 |
<a name="l00076"></a>00076 3. Design and Implementation</a></h2> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
87 |
<a name="l00077"></a>00077 The following component diagram illustrates the split of classes over the Client and Server components, and their inter-relationships.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
88 |
<a name="l00078"></a>00078 <div align=<span class="stringliteral">"center"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
89 |
<a name="l00079"></a>00079 <img src=<span class="stringliteral">"client-server_components.jpg"</span> alt=<span class="stringliteral">"client-server_components.jpg"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
90 |
<a name="l00080"></a>00080 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
91 |
<a name="l00081"></a>00081 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
92 |
<a name="l00082"></a>00082 The client is a standard Symbian OS application, utilising an RSessionBase-derived <span class="keywordtype">object</span> to communicate with the server. The server is implemented as an EXE.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
93 |
<a name="l00083"></a>00083 In the following description, an overview of <span class="keyword">this</span> example<span class="stringliteral">'s design is presented in the Design Overview section. This is followed by a description of two use case scenarios, where the user:<ul></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
94 |
<a name="l00084"></a>00084 <span class="stringliteral"><li>Invokes the application - here, the application establishes communication with the server, creating the server if necessary. This is achieved using the <a class="el" href="class_r_time_server_session.html">RTimeServerSession</a> class, and is described in the Creating a session section.</li><li>Makes a server request - the application uses the established session to request data from the server. This is described in the Making a server request section.</li></ul></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
95 |
<a name="l00085"></a>00085 <span class="stringliteral"><p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
96 |
<a name="l00086"></a>00086 <span class="stringliteral"><hr></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
97 |
<a name="l00087"></a>00087 <span class="stringliteral"><h3><a class="anchor" name="Sub31"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
98 |
<a name="l00088"></a>00088 <span class="stringliteral">3.1 Design overview</a></h3></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
99 |
<a name="l00089"></a>00089 <span class="stringliteral">The Symbian OS client/server architecture uses four key concepts: server (CServer2), session (CSession2 and RSessionBase), sub-session (RSubSessionBase), and message (RMessage2, and RMessagePtr2).<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
100 |
<a name="l00090"></a>00090 <span class="stringliteral">Servers derive from CServer2, and are responsible for handling any requests from clients to establish connections.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
101 |
<a name="l00091"></a>00091 <span class="stringliteral">The session represents the channel of communication between client and server. Clients use a derivation of RSessionBase, and servers use a derivation from CSession2.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
102 |
<a name="l00092"></a>00092 <span class="stringliteral">The following class diagram shows the server-session associations for this example.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
103 |
<a name="l00093"></a>00093 <span class="stringliteral"><div align="center"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
104 |
<a name="l00094"></a>00094 <span class="stringliteral"><img src="server-session_classes.png" alt="server-session_classes.png"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
105 |
<a name="l00095"></a>00095 <span class="stringliteral"></div></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
106 |
<a name="l00096"></a>00096 <span class="stringliteral"><p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
107 |
<a name="l00097"></a>00097 <span class="stringliteral">A client can create multiple sessions with a server. It is more resource-efficient to use sub-sessions, but this feature is not employed in this example, for simplicity.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
108 |
<a name="l00098"></a>00098 <span class="stringliteral">The RMessage2 class is the data structure passed between client and server. The client does not manipulate this directly; they use a TIpcArgs object to package the message information that is to be sent to the server. Server side sessions read from, and write to, this structure to receive and send data.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
109 |
<a name="l00099"></a>00099 <span class="stringliteral"><hr></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
110 |
<a name="l00100"></a>00100 <span class="stringliteral"><h3><a class="anchor" name="Sub32"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
111 |
<a name="l00101"></a>00101 <span class="stringliteral">3.2 Creating a session</a></h3></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
112 |
<a name="l00102"></a>00102 <span class="stringliteral">To create a session, the client must establish a channel of communication with the server. The following diagram shows the sequence involved.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
113 |
<a name="l00103"></a>00103 <span class="stringliteral"><div align="center"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
114 |
<a name="l00104"></a>00104 <span class="stringliteral"><img src="session_sequence_diagram.png" alt="session_sequence_diagram.png"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
115 |
<a name="l00105"></a>00105 <span class="stringliteral"></div></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
116 |
<a name="l00106"></a>00106 <span class="stringliteral"><p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
117 |
<a name="l00107"></a>00107 <span class="stringliteral"><ol type=1></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
118 |
<a name="l00108"></a>00108 <span class="stringliteral"><li>Connect is called on construction of the document. This function is responsible for starting the server, if necessary, and establishing communication with the server.</li><li>It is necessary to start the server if it is not already running. StartServer accomplishes this, and returns an appropriate error code on completion. This is described further in the Starting the server section.</li><li>If the server was started successfully (or was already running), a session is created by calling the inherited CreateSession function. This takes three parameters. These are:<ul></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
119 |
<a name="l00109"></a>00109 <span class="stringliteral"><li>Server name - this is used to search for an already existing server.</li><li>Version - the lowest version of the server with which this client is compatible.</li><li>Message slots - the number of asynchronous message requests that the client can have outstanding at any time. For a synchronous server, this is zero.</li></ul></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
120 |
<a name="l00110"></a>00110 <span class="stringliteral"></li><li>The CreateSession function calls corresponding function from kernel side. The actual name of this function is undocumented.</li><li>The kernel layer calls the server'</span>s NewSessionL function. The exact mechanism is not documented but is included to show the complete sequence of events. NewSessionL verifies the client version, returning an error <span class="keywordflow">if</span> it is not compatible with the server. It then creates a <span class="keyword">new</span> <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_time_server_session.html"</span>><a class="code" href="class_c_time_server_session.html">CTimeServerSession</a></a> to handle the client/server communication.</li><li>The session is created <span class="keyword">using</span> the standard Symbian OS two-phase construction.</li><li>The <span class="keyword">new</span> session is registered with the server, <span class="keyword">using</span> IncrementSessions. The server keeps a count of the number of open sessions. The DecrementSessions function is called when a server session is destroyed, and terminates the server when there are no more open sessions.</li></ol> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
121 |
<a name="l00111"></a>00111 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
122 |
<a name="l00112"></a>00112 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
123 |
<a name="l00113"></a>00113 <h3><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Sub321"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
124 |
<a name="l00114"></a>00114 3.2.1 Starting the server</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
125 |
<a name="l00115"></a>00115 A server needs its own thread of execution. In <span class="keyword">this</span> example, the client uses StartServer to check whether the server is running. If the server is not running, a thread is created and the server is started.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
126 |
<a name="l00116"></a>00116 The following diagram shows the sequence involved in creating the server.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
127 |
<a name="l00117"></a>00117 <div align=<span class="stringliteral">"center"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
128 |
<a name="l00118"></a>00118 <img src=<span class="stringliteral">"start_server_sequence.png"</span> alt=<span class="stringliteral">"start_server_sequence.png"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
129 |
<a name="l00119"></a>00119 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
130 |
<a name="l00120"></a>00120 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
131 |
<a name="l00121"></a>00121 <ol type=1> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
132 |
<a name="l00122"></a>00122 <li>The StartServer function attempts to find an already running server. If it cannot, it will create a <span class="keyword">new</span> server, waiting until the server has been created before returning.</li><li>A <span class="keyword">new</span> TFindServer <span class="keywordtype">object</span> is created with the server name to search <span class="keywordflow">for</span>.</li><li>The call to TFindServer::Next returns KErrNone <span class="keywordflow">if</span> the server was found.</li><li>A <span class="keyword">new</span> RSemaphore is created.</li><li>The call to RSemaphore::CreateGlobal is passed the semaphore name to use. The semaphore needs to be global since the client and server run in separate processes (on the target). The server uses <span class="keyword">this</span> semaphore to tell the client when the server construction is complete.</li><li>CreateServerProcess will create and run the server. This is described in the Creating a process <span class="keywordflow">for</span> the server.</li><li>The client now waits <span class="keywordflow">for</span> the server to initialise and become ready to accept requests. It accomplishes <span class="keyword">this</span> by calling RSemaphore::Wait.</li><li>When the server issues a corresponding RSemaphore::Signal, the client will <span class="keywordflow">continue</span>. The semaphore is now closed <span class="keyword">using</span> RSemaphore::Close.</li></ol> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
133 |
<a name="l00123"></a>00123 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
134 |
<a name="l00124"></a>00124 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
135 |
<a name="l00125"></a>00125 <h3><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Sub322"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
136 |
<a name="l00126"></a>00126 3.2.2 Creating a process <span class="keywordflow">for</span> the server</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
137 |
<a name="l00127"></a>00127 The sequence involved in creating a process <span class="keywordflow">for</span> the server is shown below. On emulator it creates a thread, because server must run as a thread in the emulator<span class="stringliteral">'s process, and a process in target device.<p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
138 |
<a name="l00128"></a>00128 <span class="stringliteral"><div align="center"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
139 |
<a name="l00129"></a>00129 <span class="stringliteral"><img src="server_process_creating.png" alt="server_process_creating.png"></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
140 |
<a name="l00130"></a>00130 <span class="stringliteral"></div></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
141 |
<a name="l00131"></a>00131 <span class="stringliteral"><p></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
142 |
<a name="l00132"></a>00132 <span class="stringliteral"><ol type=1></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
143 |
<a name="l00133"></a>00133 <span class="stringliteral"><li>The CreateServerProcess function is responsible for creating a process for the server to run in, then starting the server.</li><li>A handle for manipulating the server is created using RProcess::Create.</li><li>The RProcess::Create is supplied with three parameters. These are:<ul></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
144 |
<a name="l00134"></a>00134 <span class="stringliteral"><li>Server file name - the name of the server, including the path, to be executed.</li><li>Parameters - any data to be passed to the server (in this case, no data is passed).</li><li>UID - the UID of the server executable.</li></ul></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
145 |
<a name="l00135"></a>00135 <span class="stringliteral"></li><li>The process has now been created by the kernel. The process is suspended until a call to RProcess::Resume is made.</li><li>The process is signalled to start by calling RProcess::Resume.</li><li>Kernel'</span>s DProcess::Resume() is called.</li><li>The E32Main is called, which is the EXE entry point.</li><li>The E32Main call starts processing at the <a class="el" href="class_c_time_server.html<span class="preprocessor">#d575a6cfda27d2fc60179c9cf5f90663">CTimeServer::ThreadFunction</a>. This is described in the Server-side initialisation section.</li><li>The handle to the server is no longer required, and is closed. Close must be called here, otherwise this process would have an open reference to the server's process. This would prevent the process being released after the server terminates.</li></ol></span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
146 |
<a name="l00136"></a>00136 <span class="preprocessor"></span><p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
147 |
<a name="l00137"></a>00137 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
148 |
<a name="l00138"></a>00138 <h3><a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"Sub323"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
149 |
<a name="l00139"></a>00139 3.2.3 Server-side initialisation</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
150 |
<a name="l00140"></a>00140 An EXE component implements the E32Main function, which provides the API <span class="keywordflow">for</span> the operating system to start the executable. This function returns the address of the <a class="code" href="_msg_q_client_8c.html#aa6c400c3d8dbbba550d14cc697133e96">ThreadFunction</a> function to be called.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
151 |
<a name="l00141"></a>00141 The following diagram shows the initialisation the server undergoes on startup.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
152 |
<a name="l00142"></a>00142 <div align=<span class="stringliteral">"center"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
153 |
<a name="l00143"></a>00143 <img src=<span class="stringliteral">"server_startup.png"</span> alt=<span class="stringliteral">"server_startup.png"</span>> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
154 |
<a name="l00144"></a>00144 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
155 |
<a name="l00145"></a>00145 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
156 |
<a name="l00146"></a>00146 <ol type=1> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
157 |
<a name="l00147"></a>00147 <li>Kernel calls EXE entrypoint E32Main().</li><li><a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_time_server.html#d575a6cfda27d2fc60179c9cf5f90663"</span>><a class="code" href="class_c_time_server.html#af9f826864fde246cd6c53af89563ba70">CTimeServer::ThreadFunction</a></a> is responsible <span class="keywordflow">for</span> setting up any services that <span class="keyword">this</span> thread/process requires, as well as creating an instance of the <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_time_server.html"</span>><a class="code" href="class_c_time_server.html">CTimeServer</a></a> <span class="keyword">class </span>to service requests from clients. It is important to note that <a class="code" href="_msg_q_client_8c.html#aa6c400c3d8dbbba550d14cc697133e96">ThreadFunction</a> cannot leave. Any errors that occur need to be handled or must raise a panic, as there is no way to pass error information back to the calling thread.</li><li>A cleanup stack is constructed and initialised. A thread/process does not have a cleanup stack by default, so one has to be created <a class="code" href="interfacefor.html">for</a> it.</li><li><a class=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_time_server.html#be5e4a4628587739b7c76951f9577e8e"</span>>CTimeServer::ThreadFunctionL</a> is called within a TRAP to <span class="keywordflow">do</span> the remainder of the construction that can leave. Following steps 5 -14 are executed inside of <span class="keyword">this</span> function.</li><li>An active scheduler is required, to handle active objects. It is created</li><li>The active scheduler is installed.</li><li>An anonymous instance of <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_c_time_server.html"</span>><a class="code" href="class_c_time_server.html">CTimeServer</a></a> is created.</li><li>As all the work of the server is activated via the active scheduler, it is not necessary to refer to server. The ConstructL calls CServer::StartL.</li><li>The CServer::StartL call adds the server to the active scheduler and signals an active <span class="keywordtype">object</span> request.</li><li>Semaphore is created.</li><li>Handle to the global semaphore is created.</li><li>The global semaphore is signalled. This indicates that the server has now been constructed and is ready to use. The client will <span class="keywordflow">return</span> from its RSemaphore::Wait the next time that it is scheduled by the run time system.</li><li>Semaphore is closed.</li><li>The active scheduler is started by calling CActiveScheduler::Start. This function only returns when CActiveScheduler::Stop() is called, which should occur when the final client is closed. Note that an active scheduler must have a pending active <span class="keywordtype">object</span> before the call to CActiveScheduler::Start() is made. This was performed in steps 7 - 9.</li></ol> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
158 |
<a name="l00148"></a>00148 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
159 |
<a name="l00149"></a>00149 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
160 |
<a name="l00150"></a>00150 <h3><a class="anchor" name="Sub33"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
161 |
<a name="l00151"></a>00151 3.3 Making a server request</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
162 |
<a name="l00152"></a>00152 The RMessage2 class is used to transfer information between the client and the server.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
163 |
<a name="l00153"></a>00153 An instance of an RMessage2 <span class="keywordtype">object</span> is automatically created <a class="code" href="interfacefor.html">for</a> the session when the client calls the RSessionBase::SendReceive. This function can take a parameter that is a reference to TIpcArgs <span class="keywordtype">object</span>, which can contain up to four 32-bit data arguments to be passed to server.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
164 |
<a name="l00154"></a>00154 The sequence involved in making a server request is shown below.<p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
165 |
<a name="l00155"></a>00155 <div align="center"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
166 |
<a name="l00156"></a>00156 <img src="server_request.png" alt="server_request.png"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
167 |
<a name="l00157"></a>00157 </div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
168 |
<a name="l00158"></a>00158 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
169 |
<a name="l00159"></a>00159 <ol type=1> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
170 |
<a name="l00160"></a>00160 <li>RequestTime is called by the application in response to the user selecting the Display Time option. A reference to a TTime <span class="keywordtype">object</span> is passed into this function. A descriptor is now created, representing this TTime <span class="keywordtype">object</span>. This descriptor's address is added into TIpcArgs <span class="keywordtype">object</span>, which is passed to the inherited SendReceive function.</li><li>The call to SendReceive results in the client thread being suspended.</li><li>SendReceive calls undocumented function from kernel side.</li><li>The kernel calls the ServiceL function of the associated server session and passes the appropriate RMessage2 <span class="keywordtype">object</span>. This <span class="keywordtype">object</span> specifies the operation to be performed by the server and also the message parameters. It also allows the server to indicate to the client when the request has completed, and raise a panic upon the client.</li><li>ServiceL checks the requested service using RMessage2::Function.</li><li>If requested service is ETimeServRequestTime it calls RequestTimeL, otherwise it raises a panic upon the client.</li><li>RequestTimeL calculates the current time and creates a new descriptor representing it. RMessage2::WriteL is now called with the descriptor as parameter. The first parameter of the WriteL function is index value identifying the argument. This value must be 0 because the client's descriptor is the first argument. This function call causes the time to be written to the client's address space.</li></ol> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
171 |
<a name="l00161"></a>00161 <p> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
172 |
<a name="l00162"></a>00162 <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
173 |
<a name="l00163"></a>00163 <h3><a class="anchor" name="Sub34"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
174 |
<a name="l00164"></a>00164 3.4 Capabilities</a></h3> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
175 |
<a name="l00165"></a>00165 The application does not require any capabilities. The program capabilities are defined in both mmp-files as CAPABILITY NONE. <hr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
176 |
<a name="l00166"></a>00166 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
177 |
<a name="l00167"></a>00167 <table x-use-null-cells |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
178 |
<a name="l00168"></a>00168 style="x-cell-content-align: top; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
179 |
<a name="l00169"></a>00169 width: 100%; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
180 |
<a name="l00170"></a>00170 border-spacing: 0px; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
181 |
<a name="l00171"></a>00171 border-spacing: 0px;" |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
182 |
<a name="l00172"></a>00172 cellspacing=0 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
183 |
<a name="l00173"></a>00173 width=100%> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
184 |
<a name="l00174"></a>00174 <col style="width: 50%;"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
185 |
<a name="l00175"></a>00175 <col style="width: 50%;"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
186 |
<a name="l00176"></a>00176 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
187 |
<a name="l00177"></a>00177 <tr style="x-cell-content-align: top;" |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
188 |
<a name="l00178"></a>00178 valign=top> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
189 |
<a name="l00179"></a>00179 <td style="width: 50%; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
190 |
<a name="l00180"></a>00180 padding-right: 10px; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
191 |
<a name="l00181"></a>00181 padding-left: 10px; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
192 |
<a name="l00182"></a>00182 border-right-style: None; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
193 |
<a name="l00183"></a>00183 border-left-style: None; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
194 |
<a name="l00184"></a>00184 border-top-style: None; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
195 |
<a name="l00185"></a>00185 border-bottom-style: None;" |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
196 |
<a name="l00186"></a>00186 width=50%> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
197 |
<a name="l00187"></a>00187 <p style="font-family: Arial;"><small style="font-size: smaller;">© Nokia 2009</small></td> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
198 |
<a name="l00188"></a>00188 <td style="width: 50%; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
199 |
<a name="l00189"></a>00189 padding-right: 10px; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
200 |
<a name="l00190"></a>00190 padding-left: 10px; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
201 |
<a name="l00191"></a>00191 border-top-style: None; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
202 |
<a name="l00192"></a>00192 border-bottom-style: None; |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
203 |
<a name="l00193"></a>00193 border-right-style: None;" |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
204 |
<a name="l00194"></a>00194 width=50%> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
205 |
<a name="l00195"></a>00195 <p style="text-align: right; margin-right: -4px;" |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
206 |
<a name="l00196"></a>00196 align=right><span style="font-weight: bold;"><a href="<span class="preprocessor">#Top"</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
207 |
<a name="l00197"></a>00197 <span class="preprocessor"></span> title=<span class="stringliteral">"Back to top"</span>><img |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
208 |
<a name="l00198"></a>00198 src=<span class="stringliteral">"top.gif"</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
209 |
<a name="l00199"></a>00199 x-maintain-ratio=TRUE |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
210 |
<a name="l00200"></a>00200 alt=<span class="stringliteral">"Back to top"</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
211 |
<a name="l00201"></a>00201 style=<span class="stringliteral">"border: none;</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
212 |
<a name="l00202"></a>00202 <span class="stringliteral"> width: 18px;</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
213 |
<a name="l00203"></a>00203 <span class="stringliteral"> height: 15px;</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
214 |
<a name="l00204"></a>00204 <span class="stringliteral"> float: none;</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
215 |
<a name="l00205"></a>00205 <span class="stringliteral"> border-style: none;</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
216 |
<a name="l00206"></a>00206 <span class="stringliteral"> border-style: none;"</span> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
217 |
<a name="l00207"></a>00207 width=18 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
218 |
<a name="l00208"></a>00208 height=15 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
219 |
<a name="l00209"></a>00209 border=0></a></span></td></tr> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
220 |
<a name="l00210"></a>00210 </table> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
221 |
<a name="l00211"></a>00211 </body> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
222 |
<a name="l00212"></a>00212 </html> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
223 |
<a name="l00213"></a>00213 |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
224 |
</pre></div></div> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
225 |
<hr size="1"/><address style="text-align: right;"><small>Generated by |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
226 |
<a href="http://www.doxygen.org/index.html"> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
227 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
228 |
</body> |
43e37759235e
Week 12 contribution of example code"
Dominic Pinkman <Dominic.Pinkman@Nokia.com>
parents:
diff
changeset
|
229 |
</html> |