Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_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: CTimeServerSession 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>CTimeServerSession Class Reference</h1><!-- doxytag: class="CTimeServerSession" --><!-- doxytag: inherits="CSession2,CSession2" -->
<p>Inherits CSession2, and CSession2.</p>
<p><a href="class_c_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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#aa53019c11a98c408e6840e8411a57e82">~CTimeServerSession</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a5db282a872864d62b94a2a6a25159d5f">SendTimeToClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a0fd8da10042e0e7c97a74eef7f1fe413">ServiceL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#af1b23ab983d4b893a13ff378008ae769">~CTimeServerSession</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a0fd8da10042e0e7c97a74eef7f1fe413">ServiceL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a79d62e9984113a28d147f151788ea80e">NewL</a> (<a class="el" href="class_c_time_server.html">CTimeServer</a> &aServer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#af7b2cd8196f1b5b4e84e20f38b9ce59b">NewLC</a> (<a class="el" href="class_c_time_server.html">CTimeServer</a> &aServer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a057a0e8ce336197b792aaf66a7391b8f">NewL</a> (<a class="el" href="class_c_time_server.html">CTimeServer</a> &aServer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a2127d05db89623f5558a9f09d01c8ab3">NewLC</a> (<a class="el" href="class_c_time_server.html">CTimeServer</a> &aServer)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_time_server_session.html">CTimeServerSession</a>. An instance of class <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> is created for each client. </p>
<p>Definition at line <a class="el" href="_client_server_async_2server_2inc_2timesession_8h_source.html#l00031">31</a> of file <a class="el" href="_client_server_async_2server_2inc_2timesession_8h_source.html">timesession.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa53019c11a98c408e6840e8411a57e82"></a><!-- doxytag: member="CTimeServerSession::~CTimeServerSession" ref="aa53019c11a98c408e6840e8411a57e82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTimeServerSession::~CTimeServerSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment"><span class="stringliteral">"fragment"</span>><pre <span class="keyword">class</span>=<span class="stringliteral">"fragment"</span>><a name=<span class="stringliteral">"l00122"</span>></a>00122 {
<a name=<span class="stringliteral">"l00123"</span>></a>00123 <a <span class="keyword">class</span>=<span class="stringliteral">"code"</span> href=<span class="stringliteral">"class_c_time_server.html#40ac9219e4400c125719d767d564fc3e"</span>>iSessionCount</a>--;
<a name=<span class="stringliteral">"l00124"</span>></a>00124 <span <span class="keyword">class</span>=<span class="stringliteral">"keywordflow"</span>><span class="keywordflow">if</span></span> ( <a <span class="keyword">class</span>=<span class="stringliteral">"code"</span> href=<span class="stringliteral">"class_c_time_server.html#40ac9219e4400c125719d767d564fc3e"</span>>iSessionCount</a> &lt;= 0 )
<a name=<span class="stringliteral">"l00125"</span>></a>00125 {
<a name=<span class="stringliteral">"l00126"</span>></a>00126 CActiveScheduler::Stop();
<a name=<span class="stringliteral">"l00127"</span>></a>00127 }
<a name=<span class="stringliteral">"l00128"</span>></a>00128 }
</pre></div>
<p>
</td>
</tr>
</table>
<a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"a8205372b5d379fa4b803e98b0726473"</span>></a><!-- doxytag: member=<span class="stringliteral">"CTimeServer::WaitForTickL"</span> ref=<span class="stringliteral">"a8205372b5d379fa4b803e98b0726473"</span> args=<span class="stringliteral">"()"</span> --><p>
<table <span class="keyword">class</span>=<span class="stringliteral">"mdTable"</span> cellpadding=<span class="stringliteral">"2"</span> cellspacing=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdRow"</span>>
<table cellpadding=<span class="stringliteral">"0"</span> cellspacing=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> nowrap valign=<span class="stringliteral">"top"</span>><span class="keywordtype">void</span> <a class="code" href="class_c_time_server.html#a6787f6b173c59446b202ae04177a5d88">CTimeServer::WaitForTickL</a> </td>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>(&nbsp;</td>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdname1"</span> valign=<span class="stringliteral">"top"</span> nowrap> </td>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>&nbsp;)&nbsp
</pre></div><p>~CTimeServerSession. Destructor. </p>
<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html#l00077">77</a> of file <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html">timesession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af1b23ab983d4b893a13ff378008ae769"></a><!-- doxytag: member="CTimeServerSession::~CTimeServerSession" ref="af1b23ab983d4b893a13ff378008ae769" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CTimeServerSession::~CTimeServerSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CTimeServerSession. Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a79d62e9984113a28d147f151788ea80e"></a><!-- doxytag: member="CTimeServerSession::NewL" ref="a79d62e9984113a28d147f151788ea80e" args="(CTimeServer &aServer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> * CTimeServerSession::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_time_server.html">CTimeServer</a> & </td>
<td class="paramname"> <em>aServer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL. Two-phased constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aServer</em> </td><td>The server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> object. </dd></dl>
<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html#l00031">31</a> of file <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html">timesession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af7b2cd8196f1b5b4e84e20f38b9ce59b"></a><!-- doxytag: member="CTimeServerSession::NewLC" ref="af7b2cd8196f1b5b4e84e20f38b9ce59b" args="(CTimeServer &aServer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> * CTimeServerSession::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_time_server.html">CTimeServer</a> & </td>
<td class="paramname"> <em>aServer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewLC. Two-phased constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aServer</em> </td><td>The server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> object. </dd></dl>
<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html#l00043">43</a> of file <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html">timesession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5db282a872864d62b94a2a6a25159d5f"></a><!-- doxytag: member="CTimeServerSession::SendTimeToClient" ref="a5db282a872864d62b94a2a6a25159d5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimeServerSession::SendTimeToClient </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>SendTimeToClient. Call from Beat() and Synchronize(). Sends current time back to requesting client. </p>
<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html#l00138">138</a> of file <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html">timesession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0fd8da10042e0e7c97a74eef7f1fe413"></a><!-- doxytag: member="CTimeServerSession::ServiceL" ref="a0fd8da10042e0e7c97a74eef7f1fe413" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimeServerSession::ServiceL </td>
<td>(</td>
<td class="paramtype">const RMessage2 & </td>
<td class="paramname"> <em>aMessage</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CSession, ServiceL. Service request from client. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessage</em> </td><td>Message from client (containing requested operation and any data). </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html#l00087">87</a> of file <a class="el" href="_client_server_async_2server_2src_2timesession_8cpp_source.html">timesession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a057a0e8ce336197b792aaf66a7391b8f"></a><!-- doxytag: member="CTimeServerSession::NewL" ref="a057a0e8ce336197b792aaf66a7391b8f" args="(CTimeServer &aServer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a>* CTimeServerSession::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_time_server.html">CTimeServer</a> & </td>
<td class="paramname"> <em>aServer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL. Two-phased constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aServer</em> </td><td>The server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> object. </dd></dl>
</div>
</div>
<a class="anchor" id="a2127d05db89623f5558a9f09d01c8ab3"></a><!-- doxytag: member="CTimeServerSession::NewLC" ref="a2127d05db89623f5558a9f09d01c8ab3" args="(CTimeServer &aServer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a>* CTimeServerSession::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_time_server.html">CTimeServer</a> & </td>
<td class="paramname"> <em>aServer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewLC. Two-phased constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aServer</em> </td><td>The server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> object. </dd></dl>
</div>
</div>
<a class="anchor" id="a0fd8da10042e0e7c97a74eef7f1fe413"></a><!-- doxytag: member="CTimeServerSession::ServiceL" ref="a0fd8da10042e0e7c97a74eef7f1fe413" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimeServerSession::ServiceL </td>
<td>(</td>
<td class="paramtype">const RMessage2 & </td>
<td class="paramname"> <em>aMessage</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CSession, ServiceL. Service request from client. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aMessage</em> </td><td>Message from client (containing requested operation and any data). </td></tr>
</table>
</dd>
</dl>
</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>