00001 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
00002 <html>
00003
00004 <head>
00005 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
00006 <title>RTimeServerSession Class Reference</title>
00007 <link href="style.css" rel="stylesheet" type="text/css">
00008 </head>
00009
00010 <table border="0" width="100%" height="8" bgcolor="#eeeeee">
00011 <tr> <td width="100%" height="1"><b><font size="2" color="#000000" face="Arial, Helvetica, sans-serif"><strong><a name=Top></a>
00012 S60 5th Edition SDK </strong></font></b><br><i>Example Applications Guide</i></td></tr> </table>
00013 <!-- Generated by Doxygen 1.4.5 -->
00014 <div class="tabs">
00015 <ul>
00016 <li><a href="index.html"><span>Main Page</span></a></li>
00017 <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
00018 <li><a href="files.html"><span>Files</span></a></li>
00019 </ul></div>
00020 <div class="tabs">
00021 <ul>
00022 <li><a href="annotated.html"><span>Class List</span></a></li>
00023 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
00024 <li><a href="functions.html"><span>Class Members</span></a></li>
00025 </ul></div>
00026 <h1>RTimeServerSession Class Reference</h1><!-- doxytag: class="RTimeServerSession" --><!-- doxytag: inherits="RSessionBase" --><code>#include <<a class="el" href="timeserversession_8h-source.html">timeserversession.h</a>></code>
00027 <p>
00028 <p>Inheritance diagram for RTimeServerSession:
00029 <p><center><img src="class_r_time_server_session.png" usemap="#RTimeServerSession_map" border="0" alt=""></center>
00030 <map name="RTimeServerSession_map">
00031 </map>
00032 <a href="class_r_time_server_session-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
00033 RTimeServerSession This class provides the client-side interface to the server session
00034 <p>
00035
00036 <p>
00037 Definition at line <a class="el" href="timeserversession_8h-source.html#l00043">43</a> of file <a class="el" href="timeserversession_8h-source.html">timeserversession.h</a>.<table border="0" cellpadding="0" cellspacing="0">
00038 <tr><td></td></tr>
00039 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
00040 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#d8a4b16d15242f1f1a1e7e2585bf81a6">RTimeServerSession</a> ()</td></tr>
00041
00042 <tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#0a20867f2777f1db7349df290a5e6112">Connect</a> ()</td></tr>
00043
00044 <tr><td class="memItemLeft" nowrap align="right" valign="top">TVersion </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#30dc24843f42888ea13e6093f6318f37">Version</a> () const </td></tr>
00045
00046 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#0e65b7c45b7af042183f1c5525cfcc1b">RequestTime</a> (TTime &aTime, TRequestStatus &aStatus)</td></tr>
00047
00048 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#52a5f2cddd36f215fea9c11e32ab88b8">CancelRequestTime</a> () const </td></tr>
00049
00050 <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
00051 <tr><td class="memItemLeft" nowrap align="right" valign="top">TPtr8 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#828f90acd9ecd7a6283a9226001e3921">iTimeBuffer</a></td></tr>
00052
00053 </table>
00054 <hr><h2>Constructor & Destructor Documentation</h2>
00055 <a class="anchor" name="d8a4b16d15242f1f1a1e7e2585bf81a6"></a><!-- doxytag: member="RTimeServerSession::RTimeServerSession" ref="d8a4b16d15242f1f1a1e7e2585bf81a6" args="()" --><p>
00056 <table class="mdTable" cellpadding="2" cellspacing="0">
00057 <tr>
00058 <td class="mdRow">
00059 <table cellpadding="0" cellspacing="0" border="0">
00060 <tr>
00061 <td class="md" nowrap valign="top">RTimeServerSession::RTimeServerSession </td>
00062 <td class="md" valign="top">( </td>
00063 <td class="mdname1" valign="top" nowrap> </td>
00064 <td class="md" valign="top"> ) </td>
00065 <td class="md" nowrap></td>
00066 </tr>
00067 </table>
00068 </td>
00069 </tr>
00070 </table>
00071 <table cellspacing="5" cellpadding="0" border="0">
00072 <tr>
00073 <td>
00074
00075 </td>
00076 <td>
00077
00078 <p>
00079 RTimeServerSession. Constructs the object.
00080 <p>
00081 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00034">34</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00035"></a>00035 : RSessionBase(), <a class="code" href="class_r_time_server_session.html#828f90acd9ecd7a6283a9226001e3921">iTimeBuffer</a>( NULL, 0, 0 )
00082 <a name="l00036"></a>00036 {
00083 <a name="l00037"></a>00037 <span class="comment">
00084 <a name="l00038"></a>00038 }
00085 </pre></div>
00086 <p>
00087 </td>
00088 </tr>
00089 </table>
00090 <hr><h2>Member Function Documentation</h2>
00091 <a class="anchor" name="0a20867f2777f1db7349df290a5e6112"></a><!-- doxytag: member="RTimeServerSession::Connect" ref="0a20867f2777f1db7349df290a5e6112" args="()" --><p>
00092 <table class="mdTable" cellpadding="2" cellspacing="0">
00093 <tr>
00094 <td class="mdRow">
00095 <table cellpadding="0" cellspacing="0" border="0">
00096 <tr>
00097 <td class="md" nowrap valign="top">TInt RTimeServerSession::Connect </td>
00098 <td class="md" valign="top">( </td>
00099 <td class="mdname1" valign="top" nowrap> </td>
00100 <td class="md" valign="top"> ) </td>
00101 <td class="md" nowrap></td>
00102 </tr>
00103 </table>
00104 </td>
00105 </tr>
00106 </table>
00107 <table cellspacing="5" cellpadding="0" border="0">
00108 <tr>
00109 <td>
00110
00111 </td>
00112 <td>
00113
00114 <p>
00115 Connect. Connects to the server and create a session. <dl compact><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
00116
00117 <p>
00118 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00045">45</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00119 <p>
00120 References <a class="el" href="timeserversession_8cpp-source.html#l00063">Version()</a>.
00121 <p>
00122 Referenced by <a class="el" href="csasyncrequesthandler_8cpp-source.html#l00057">CCSAsyncRequestHandler::ConstructL()</a>.<div class="fragment"><pre class="fragment"><a name="l00046"></a>00046 {
00123 <a name="l00047"></a>00047 TInt error = ::StartServer();
00124 <a name="l00048"></a>00048
00125 <a name="l00049"></a>00049 <span class="keywordflow">if</span> ( KErrNone == error )
00126 <a name="l00050"></a>00050 {
00127 <a name="l00051"></a>00051 error = CreateSession( KTimeServerName,
00128 <a name="l00052"></a>00052 Version(),
00129 <a name="l00053"></a>00053 KDefaultMessageSlots );
00130 <a name="l00054"></a>00054 }
00131 <a name="l00055"></a>00055 <span class="keywordflow">return</span> error;
00132 <a name="l00056"></a>00056 }
00133 </pre></div>
00134 <p>
00135 </td>
00136 </tr>
00137 </table>
00138 <a class="anchor" name="30dc24843f42888ea13e6093f6318f37"></a><!-- doxytag: member="RTimeServerSession::Version" ref="30dc24843f42888ea13e6093f6318f37" args="() const " --><p>
00139 <table class="mdTable" cellpadding="2" cellspacing="0">
00140 <tr>
00141 <td class="mdRow">
00142 <table cellpadding="0" cellspacing="0" border="0">
00143 <tr>
00144 <td class="md" nowrap valign="top">TVersion RTimeServerSession::Version </td>
00145 <td class="md" valign="top">( </td>
00146 <td class="mdname1" valign="top" nowrap> </td>
00147 <td class="md" valign="top"> ) </td>
00148 <td class="md" nowrap> const</td>
00149 </tr>
00150 </table>
00151 </td>
00152 </tr>
00153 </table>
00154 <table cellspacing="5" cellpadding="0" border="0">
00155 <tr>
00156 <td>
00157
00158 </td>
00159 <td>
00160
00161 <p>
00162 Version. Gets the version number. <dl compact><dt><b>Returns:</b></dt><dd>The version. </dd></dl>
00163
00164 <p>
00165 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00063">63</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00166 <p>
00167 Referenced by <a class="el" href="timeserversession_8cpp-source.html#l00045">Connect()</a>.<div class="fragment"><pre class="fragment"><a name="l00064"></a>00064 {
00168 <a name="l00065"></a>00065 <span class="keywordflow">return</span>( TVersion( KTimeServMajorVersionNumber,
00169 <a name="l00066"></a>00066 KTimeServMinorVersionNumber,
00170 <a name="l00067"></a>00067 KTimeServBuildVersionNumber ) );
00171 <a name="l00068"></a>00068 }
00172 </pre></div>
00173 <p>
00174 </td>
00175 </tr>
00176 </table>
00177 <a class="anchor" name="0e65b7c45b7af042183f1c5525cfcc1b"></a><!-- doxytag: member="RTimeServerSession::RequestTime" ref="0e65b7c45b7af042183f1c5525cfcc1b" args="(TTime &aTime, TRequestStatus &aStatus)" --><p>
00178 <table class="mdTable" cellpadding="2" cellspacing="0">
00179 <tr>
00180 <td class="mdRow">
00181 <table cellpadding="0" cellspacing="0" border="0">
00182 <tr>
00183 <td class="md" nowrap valign="top">void RTimeServerSession::RequestTime </td>
00184 <td class="md" valign="top">( </td>
00185 <td class="md" nowrap valign="top">TTime & </td>
00186 <td class="mdname" nowrap> <em>aTime</em>, </td>
00187 </tr>
00188 <tr>
00189 <td class="md" nowrap align="right"></td>
00190 <td class="md"></td>
00191 <td class="md" nowrap>TRequestStatus & </td>
00192 <td class="mdname" nowrap> <em>aStatus</em></td>
00193 </tr>
00194 <tr>
00195 <td class="md"></td>
00196 <td class="md">) </td>
00197 <td class="md" colspan="2"></td>
00198 </tr>
00199 </table>
00200 </td>
00201 </tr>
00202 </table>
00203 <table cellspacing="5" cellpadding="0" border="0">
00204 <tr>
00205 <td>
00206
00207 </td>
00208 <td>
00209
00210 <p>
00211 RequestTime. Issues a request for the time to the server. <dl compact><dt><b>Parameters:</b></dt><dd>
00212 <table border="0" cellspacing="2" cellpadding="0">
00213 <tr><td valign="top"></td><td valign="top"><em>aTime</em> </td><td>The location for the server to write data into. </td></tr>
00214 <tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>The TRequestStatus object to be used for async comms. </td></tr>
00215 </table>
00216 </dl>
00217
00218 <p>
00219 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00075">75</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00220 <p>
00221 References <a class="el" href="timeserversession_8h-source.html#l00088">iTimeBuffer</a>.
00222 <p>
00223 Referenced by <a class="el" href="csasyncrequesthandler_8cpp-source.html#l00088">CCSAsyncRequestHandler::RequestTime()</a>.<div class="fragment"><pre class="fragment"><a name="l00076"></a>00076 {
00224 <a name="l00077"></a>00077 <a class="code" href="class_r_time_server_session.html#828f90acd9ecd7a6283a9226001e3921">iTimeBuffer</a>.Set( reinterpret_cast<TUint8*>( &aTime ), <span class="keyword">sizeof</span>( aTime ),
00225 <a name="l00078"></a>00078 <span class="keyword">sizeof</span>( aTime ) );
00226 <a name="l00079"></a>00079
00227 <a name="l00080"></a>00080 <span class="comment">
00228 <a name="l00081"></a>00081 TIpcArgs args( &<a class="code" href="class_r_time_server_session.html#828f90acd9ecd7a6283a9226001e3921">iTimeBuffer</a> );
00229 <a name="l00082"></a>00082
00230 <a name="l00083"></a>00083 <span class="comment">
00231 <a name="l00084"></a>00084 <span class="comment">
00232 <a name="l00085"></a>00085 <span class="comment">
00233 <a name="l00086"></a>00086 <span class="comment">
00234 <a name="l00087"></a>00087 SendReceive( ETimeServRequestTime, args, aStatus );
00235 <a name="l00088"></a>00088 }
00236 </pre></div>
00237 <p>
00238 </td>
00239 </tr>
00240 </table>
00241 <a class="anchor" name="52a5f2cddd36f215fea9c11e32ab88b8"></a><!-- doxytag: member="RTimeServerSession::CancelRequestTime" ref="52a5f2cddd36f215fea9c11e32ab88b8" args="() const " --><p>
00242 <table class="mdTable" cellpadding="2" cellspacing="0">
00243 <tr>
00244 <td class="mdRow">
00245 <table cellpadding="0" cellspacing="0" border="0">
00246 <tr>
00247 <td class="md" nowrap valign="top">void RTimeServerSession::CancelRequestTime </td>
00248 <td class="md" valign="top">( </td>
00249 <td class="mdname1" valign="top" nowrap> </td>
00250 <td class="md" valign="top"> ) </td>
00251 <td class="md" nowrap> const</td>
00252 </tr>
00253 </table>
00254 </td>
00255 </tr>
00256 </table>
00257 <table cellspacing="5" cellpadding="0" border="0">
00258 <tr>
00259 <td>
00260
00261 </td>
00262 <td>
00263
00264 <p>
00265 CancelRequestTime. Cancels any outstanding request to the server.
00266 <p>
00267 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00094">94</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00268 <p>
00269 Referenced by <a class="el" href="csasyncrequesthandler_8cpp-source.html#l00141">CCSAsyncRequestHandler::DoCancel()</a>.<div class="fragment"><pre class="fragment"><a name="l00095"></a>00095 {
00270 <a name="l00096"></a>00096 SendReceive( ETimeServCancelRequestTime, TIpcArgs(NULL) );
00271 <a name="l00097"></a>00097 }
00272 </pre></div>
00273 <p>
00274 </td>
00275 </tr>
00276 </table>
00277 <hr><h2>Member Data Documentation</h2>
00278 <a class="anchor" name="828f90acd9ecd7a6283a9226001e3921"></a><!-- doxytag: member="RTimeServerSession::iTimeBuffer" ref="828f90acd9ecd7a6283a9226001e3921" args="" --><p>
00279 <table class="mdTable" cellpadding="2" cellspacing="0">
00280 <tr>
00281 <td class="mdRow">
00282 <table cellpadding="0" cellspacing="0" border="0">
00283 <tr>
00284 <td class="md" nowrap valign="top">TPtr8 <a class="el" href="class_r_time_server_session.html#828f90acd9ecd7a6283a9226001e3921">RTimeServerSession::iTimeBuffer</a><code> [private]</code> </td>
00285 </tr>
00286 </table>
00287 </td>
00288 </tr>
00289 </table>
00290 <table cellspacing="5" cellpadding="0" border="0">
00291 <tr>
00292 <td>
00293
00294 </td>
00295 <td>
00296
00297 <p>
00298 iTimeBuffer, buffer to write the time to.
00299 <p>
00300 Definition at line <a class="el" href="timeserversession_8h-source.html#l00088">88</a> of file <a class="el" href="timeserversession_8h-source.html">timeserversession.h</a>.
00301 <p>
00302 Referenced by <a class="el" href="timeserversession_8cpp-source.html#l00075">RequestTime()</a>. </td>
00303 </tr>
00304 </table>
00305 <hr>The documentation for this class was generated from the following files:<ul>
00306 <li><a class="el" href="timeserversession_8h-source.html">timeserversession.h</a><li><a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a></ul>
00307 <hr>
00308
00309 <table x-use-null-cells
00310 style="x-cell-content-align: top;
00311 width: 100%;
00312 border-spacing: 0px;
00313 border-spacing: 0px;"
00314 cellspacing=0
00315 width=100%>
00316 <col style="width: 50%;">
00317 <col style="width: 50%;">
00318
00319 <tr style="x-cell-content-align: top;"
00320 valign=top>
00321 <td style="width: 50%;
00322 padding-right: 10px;
00323 padding-left: 10px;
00324 border-right-style: None;
00325 border-left-style: None;
00326 border-top-style: None;
00327 border-bottom-style: None;"
00328 width=50%>
00329 <p style="font-family: Arial;"><small style="font-size: smaller;">� Nokia 2009</small></td>
00330 <td style="width: 50%;
00331 padding-right: 10px;
00332 padding-left: 10px;
00333 border-top-style: None;
00334 border-bottom-style: None;
00335 border-right-style: None;"
00336 width=50%>
00337 <p style="text-align: right; margin-right: -4px;"
00338 align=right><span style="font-weight: bold;"><a href="#Top"
00339 title="Back to top"><img
00340 src="top.gif"
00341 x-maintain-ratio=TRUE
00342 alt="Back to top"
00343 style="border: none;
00344 width: 18px;
00345 height: 15px;
00346 float: none;
00347 border-style: none;
00348 border-style: none;"
00349 width=18
00350 height=15
00351 border=0></a></span></td></tr>
00352 </table>
00353 </body>
00354 </html>
00355