Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_time_server_session.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: RTimeServerSession Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>RTimeServerSession Class Reference</h1><!-- doxytag: class="RTimeServerSession" --><!-- doxytag: inherits="RSessionBase,RSessionBase" -->
<p>Inherits RSessionBase, and RSessionBase.</p>
<p><a href="class_r_time_server_session-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a1b1d498de395c8c97e6e74e5b17a463f">RTimeServerSession</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a21ea524d4ff3c0622035d60c8a4c5f62">Connect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TVersion </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a2c3e9d93ee99036775f915b5c9a0ae77">Version</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a456203c7ad8889a4753222e98173ff00">RequestTime</a> (TTime &aTime, TRequestStatus &aStatus)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#af8ab12245c507789cdc592212463be5e">CancelRequestTime</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a1b1d498de395c8c97e6e74e5b17a463f">RTimeServerSession</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a070189bc1a6b41ecee4cc79482152bc8">Connect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TVersion </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a2c3e9d93ee99036775f915b5c9a0ae77">Version</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_time_server_session.html#a9204e678b108676f3efeb2eb720d12cd">RequestTime</a> (TTime &aTime) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_r_time_server_session.html">RTimeServerSession</a> This class provides the client-side interface to the server session </p>
<p>Definition at line <a class="el" href="_client_server_async_2client_2inc_2timeserversession_8h_source.html#l00043">43</a> of file <a class="el" href="_client_server_async_2client_2inc_2timeserversession_8h_source.html">timeserversession.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1b1d498de395c8c97e6e74e5b17a463f"></a><!-- doxytag: member="RTimeServerSession::RTimeServerSession" ref="a1b1d498de395c8c97e6e74e5b17a463f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTimeServerSession::RTimeServerSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_r_time_server_session.html">RTimeServerSession</a>. Constructs the object. </p>
<p>Definition at line <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html#l00034">34</a> of file <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html">timeserversession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1b1d498de395c8c97e6e74e5b17a463f"></a><!-- doxytag: member="RTimeServerSession::RTimeServerSession" ref="a1b1d498de395c8c97e6e74e5b17a463f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTimeServerSession::RTimeServerSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_r_time_server_session.html">RTimeServerSession</a>. Constructs the object. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a21ea524d4ff3c0622035d60c8a4c5f62"></a><!-- doxytag: member="RTimeServerSession::Connect" ref="a21ea524d4ff3c0622035d60c8a4c5f62" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"></td >< td >< p > ConstructL Performs the second phase construction of a <a class="el" href="class_c_c_s_sync_document.html">CCSSyncDocument</a> object< p > Definition at line< a class="el"href="cssyncdocument_8cpp-source.html#l00053"></a > of file< a class="el"href="cssyncdocument_8cpp-source.html"> cssyncdocument cpp</a >< p > References< a class="el"href="timeserversession_8cpp-source.html#l00044"> RTimeServerSession::Connect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connect. Connects to the server and create a session. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
<p>Definition at line <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html#l00045">45</a> of file <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html">timeserversession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2c3e9d93ee99036775f915b5c9a0ae77"></a><!-- doxytag: member="RTimeServerSession::Version" ref="a2c3e9d93ee99036775f915b5c9a0ae77" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVersion RTimeServerSession::Version </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Version. Gets the version number. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The version. </dd></dl>
<p>Definition at line <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html#l00063">63</a> of file <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html">timeserversession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a456203c7ad8889a4753222e98173ff00"></a><!-- doxytag: member="RTimeServerSession::RequestTime" ref="a456203c7ad8889a4753222e98173ff00" args="(TTime &aTime, TRequestStatus &aStatus)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTimeServerSession::RequestTime </td>
<td>(</td>
<td class="paramtype">TTime & </td>
<td class="paramname"> <em>aTime</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>RequestTime. Issues a request for the time to the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTime</em> </td><td>The location for the server to write data into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>The TRequestStatus object to be used for async comms. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html#l00075">75</a> of file <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html">timeserversession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af8ab12245c507789cdc592212463be5e"></a><!-- doxytag: member="RTimeServerSession::CancelRequestTime" ref="af8ab12245c507789cdc592212463be5e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTimeServerSession::CancelRequestTime </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>CancelRequestTime. Cancels any outstanding request to the server. </p>
<p>Definition at line <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html#l00094">94</a> of file <a class="el" href="_client_server_async_2client_2src_2timeserversession_8cpp_source.html">timeserversession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a070189bc1a6b41ecee4cc79482152bc8"></a><!-- doxytag: member="RTimeServerSession::Connect" ref="a070189bc1a6b41ecee4cc79482152bc8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RTimeServerSession::Connect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connect. Connects to the server and create a session. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
</div>
</div>
<a class="anchor" id="a2c3e9d93ee99036775f915b5c9a0ae77"></a><!-- doxytag: member="RTimeServerSession::Version" ref="a2c3e9d93ee99036775f915b5c9a0ae77" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVersion RTimeServerSession::Version </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Version. Gets the version number. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The version. </dd></dl>
</div>
</div>
<a class="anchor" id="a9204e678b108676f3efeb2eb720d12cd"></a><!-- doxytag: member="RTimeServerSession::RequestTime" ref="a9204e678b108676f3efeb2eb720d12cd" args="(TTime &aTime) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTimeServerSession::RequestTime </td>
<td>(</td>
<td class="paramtype">TTime & </td>
<td class="paramname"> <em>aTime</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>RequestTime. Issues a request for the time to the server. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTime</em> </td><td>The location for the server to write data into. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_client_server_sync_2client_2src_2timeserversession_8cpp_source.html#l00074">74</a> of file <a class="el" href="_client_server_sync_2client_2src_2timeserversession_8cpp_source.html">timeserversession.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>