examples/S60CppExamples/ClientServerSync/doc/class_r_time_server_session.html

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&nbsp;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&nbsp;List</span></a></li>
00023     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
00024     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
00025   </ul></div>
00026 <h1>RTimeServerSession Class Reference</h1><!-- doxytag: class="RTimeServerSession" --><!-- doxytag: inherits="RSessionBase" --><code>#include &lt;<a class="el" href="timeserversession_8h-source.html">timeserversession.h</a>&gt;</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#l00044">44</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">&nbsp;</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&nbsp;</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&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#8a47a97ea7265ef091f1f3df9641b3fa">RequestTime</a> (TTime &amp;aTime) const </td></tr>
00047 
00048 </table>
00049 <hr><h2>Constructor &amp; Destructor Documentation</h2>
00050 <a class="anchor" name="d8a4b16d15242f1f1a1e7e2585bf81a6"></a><!-- doxytag: member="RTimeServerSession::RTimeServerSession" ref="d8a4b16d15242f1f1a1e7e2585bf81a6" args="()" --><p>
00051 <table class="mdTable" cellpadding="2" cellspacing="0">
00052   <tr>
00053     <td class="mdRow">
00054       <table cellpadding="0" cellspacing="0" border="0">
00055         <tr>
00056           <td class="md" nowrap valign="top">RTimeServerSession::RTimeServerSession           </td>
00057           <td class="md" valign="top">(&nbsp;</td>
00058           <td class="mdname1" valign="top" nowrap>          </td>
00059           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00060           <td class="md" nowrap></td>
00061         </tr>
00062       </table>
00063     </td>
00064   </tr>
00065 </table>
00066 <table cellspacing="5" cellpadding="0" border="0">
00067   <tr>
00068     <td>
00069       &nbsp;
00070     </td>
00071     <td>
00072 
00073 <p>
00074 RTimeServerSession. Constructs the object. 
00075 <p>
00076 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00033">33</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00034"></a>00034 : RSessionBase()
00077 <a name="l00035"></a>00035     {
00078 <a name="l00036"></a>00036     <span class="comment">// No implementation required</span>
00079 <a name="l00037"></a>00037     }
00080 </pre></div>
00081 <p>
00082     </td>
00083   </tr>
00084 </table>
00085 <hr><h2>Member Function Documentation</h2>
00086 <a class="anchor" name="0a20867f2777f1db7349df290a5e6112"></a><!-- doxytag: member="RTimeServerSession::Connect" ref="0a20867f2777f1db7349df290a5e6112" args="()" --><p>
00087 <table class="mdTable" cellpadding="2" cellspacing="0">
00088   <tr>
00089     <td class="mdRow">
00090       <table cellpadding="0" cellspacing="0" border="0">
00091         <tr>
00092           <td class="md" nowrap valign="top">TInt RTimeServerSession::Connect           </td>
00093           <td class="md" valign="top">(&nbsp;</td>
00094           <td class="mdname1" valign="top" nowrap>          </td>
00095           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00096           <td class="md" nowrap></td>
00097         </tr>
00098       </table>
00099     </td>
00100   </tr>
00101 </table>
00102 <table cellspacing="5" cellpadding="0" border="0">
00103   <tr>
00104     <td>
00105       &nbsp;
00106     </td>
00107     <td>
00108 
00109 <p>
00110 Connect. Connects to the server and create a session. <dl compact><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
00111 
00112 <p>
00113 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00044">44</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00114 <p>
00115 References <a class="el" href="timeserversession_8cpp-source.html#l00062">Version()</a>.
00116 <p>
00117 Referenced by <a class="el" href="cssyncdocument_8cpp-source.html#l00053">CCSSyncDocument::ConstructL()</a>.<div class="fragment"><pre class="fragment"><a name="l00045"></a>00045     {
00118 <a name="l00046"></a>00046     TInt error = ::StartServer();
00119 <a name="l00047"></a>00047 
00120 <a name="l00048"></a>00048     <span class="keywordflow">if</span> ( KErrNone == error )
00121 <a name="l00049"></a>00049         {
00122 <a name="l00050"></a>00050         error = CreateSession( KTimeServerName,
00123 <a name="l00051"></a>00051                                Version(),
00124 <a name="l00052"></a>00052                                KDefaultMessageSlots );
00125 <a name="l00053"></a>00053         }
00126 <a name="l00054"></a>00054     <span class="keywordflow">return</span> error;
00127 <a name="l00055"></a>00055     }
00128 </pre></div>
00129 <p>
00130     </td>
00131   </tr>
00132 </table>
00133 <a class="anchor" name="30dc24843f42888ea13e6093f6318f37"></a><!-- doxytag: member="RTimeServerSession::Version" ref="30dc24843f42888ea13e6093f6318f37" args="() const " --><p>
00134 <table class="mdTable" cellpadding="2" cellspacing="0">
00135   <tr>
00136     <td class="mdRow">
00137       <table cellpadding="0" cellspacing="0" border="0">
00138         <tr>
00139           <td class="md" nowrap valign="top">TVersion RTimeServerSession::Version           </td>
00140           <td class="md" valign="top">(&nbsp;</td>
00141           <td class="mdname1" valign="top" nowrap>          </td>
00142           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00143           <td class="md" nowrap> const</td>
00144         </tr>
00145       </table>
00146     </td>
00147   </tr>
00148 </table>
00149 <table cellspacing="5" cellpadding="0" border="0">
00150   <tr>
00151     <td>
00152       &nbsp;
00153     </td>
00154     <td>
00155 
00156 <p>
00157 Version. Gets the version number. <dl compact><dt><b>Returns:</b></dt><dd>The version. </dd></dl>
00158 
00159 <p>
00160 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00062">62</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00161 <p>
00162 Referenced by <a class="el" href="timeserversession_8cpp-source.html#l00044">Connect()</a>.<div class="fragment"><pre class="fragment"><a name="l00063"></a>00063     {
00163 <a name="l00064"></a>00064     <span class="keywordflow">return</span>( TVersion( KTimeServMajorVersionNumber,
00164 <a name="l00065"></a>00065                       KTimeServMinorVersionNumber,
00165 <a name="l00066"></a>00066                       KTimeServBuildVersionNumber ) );
00166 <a name="l00067"></a>00067     }
00167 </pre></div>
00168 <p>
00169     </td>
00170   </tr>
00171 </table>
00172 <a class="anchor" name="8a47a97ea7265ef091f1f3df9641b3fa"></a><!-- doxytag: member="RTimeServerSession::RequestTime" ref="8a47a97ea7265ef091f1f3df9641b3fa" args="(TTime &amp;aTime) const " --><p>
00173 <table class="mdTable" cellpadding="2" cellspacing="0">
00174   <tr>
00175     <td class="mdRow">
00176       <table cellpadding="0" cellspacing="0" border="0">
00177         <tr>
00178           <td class="md" nowrap valign="top">void RTimeServerSession::RequestTime           </td>
00179           <td class="md" valign="top">(&nbsp;</td>
00180           <td class="md" nowrap valign="top">TTime &amp;&nbsp;</td>
00181           <td class="mdname1" valign="top" nowrap> <em>aTime</em>          </td>
00182           <td class="md" valign="top">&nbsp;)&nbsp;</td>
00183           <td class="md" nowrap> const</td>
00184         </tr>
00185       </table>
00186     </td>
00187   </tr>
00188 </table>
00189 <table cellspacing="5" cellpadding="0" border="0">
00190   <tr>
00191     <td>
00192       &nbsp;
00193     </td>
00194     <td>
00195 
00196 <p>
00197 RequestTime. Issues a request for the time to the server. <dl compact><dt><b>Parameters:</b></dt><dd>
00198   <table border="0" cellspacing="2" cellpadding="0">
00199     <tr><td valign="top"></td><td valign="top"><em>aTime</em>&nbsp;</td><td>The location for the server to write data into. </td></tr>
00200   </table>
00201 </dl>
00202 
00203 <p>
00204 Definition at line <a class="el" href="timeserversession_8cpp-source.html#l00074">74</a> of file <a class="el" href="timeserversession_8cpp-source.html">timeserversession.cpp</a>.
00205 <p>
00206 Referenced by <a class="el" href="cssyncdocument_8cpp-source.html#l00095">CCSSyncDocument::UpdateTime()</a>.<div class="fragment"><pre class="fragment"><a name="l00075"></a>00075     {
00207 <a name="l00076"></a>00076     <span class="comment">// Create descriptor to enable copying data between client and server.</span>
00208 <a name="l00077"></a>00077     <span class="comment">// Note: This can be local since this is a synchronous call.</span>
00209 <a name="l00078"></a>00078     <span class="comment">// Note : Using TPtr8 since this is binary information.</span>
00210 <a name="l00079"></a>00079     TPtr8 descriptor( reinterpret_cast&lt;TUint8*&gt;( &amp;aTime ), <span class="keyword">sizeof</span>( aTime ),
00211 <a name="l00080"></a>00080                       <span class="keyword">sizeof</span>( aTime ) );
00212 <a name="l00081"></a>00081     
00213 <a name="l00082"></a>00082     <span class="comment">// Package message arguments before sending to the server</span>
00214 <a name="l00083"></a>00083     TIpcArgs args( &amp;descriptor );
00215 <a name="l00084"></a>00084         
00216 <a name="l00085"></a>00085     <span class="comment">// This call waits for the server to complete the request before</span>
00217 <a name="l00086"></a>00086     <span class="comment">// proceeding. When it returns, the new time will be in aTime.</span>
00218 <a name="l00087"></a>00087     SendReceive( ETimeServRequestTime, args );
00219 <a name="l00088"></a>00088     }
00220 </pre></div>
00221 <p>
00222     </td>
00223   </tr>
00224 </table>
00225 <hr>The documentation for this class was generated from the following files:<ul>
00226 <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>
00227 <hr>
00228 
00229 <table x-use-null-cells
00230                 style="x-cell-content-align: top;
00231                                 width: 100%;
00232                                 border-spacing: 0px;
00233                                 border-spacing: 0px;"
00234                 cellspacing=0
00235                 width=100%>
00236   <col style="width: 50%;">
00237   <col style="width: 50%;">
00238 
00239   <tr style="x-cell-content-align: top;"
00240         valign=top>
00241   <td style="width: 50%;
00242                         padding-right: 10px;
00243                         padding-left: 10px;
00244                         border-right-style: None;
00245                         border-left-style: None;
00246                         border-top-style: None;
00247                         border-bottom-style: None;"
00248         width=50%>
00249   <p style="font-family: Arial;"><small style="font-size: smaller;">© Nokia 2009</small></td>
00250   <td style="width: 50%;
00251                         padding-right: 10px;
00252                         padding-left: 10px;
00253                         border-top-style: None;
00254                         border-bottom-style: None;
00255                         border-right-style: None;"
00256         width=50%>
00257   <p style="text-align: right; margin-right: -4px;"
00258         align=right><span style="font-weight: bold;"><a href="#Top"
00259                                                                                                         title="Back to top"><img
00260  src="top.gif"
00261         x-maintain-ratio=TRUE
00262         alt="Back to top"
00263         style="border: none;
00264                         width: 18px;
00265                         height: 15px;
00266                         float: none;
00267                         border-style: none;
00268                         border-style: none;"
00269         width=18
00270         height=15
00271         border=0></a></span></td></tr>
00272  </table>
00273 </body>
00274 </html>
00275 

Generated by  doxygen 1.6.2