Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_time_server_session.html
changeset 6 43e37759235e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_time_server_session.html	Tue Mar 30 16:16:55 2010 +0100
@@ -0,0 +1,280 @@
+<!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&nbsp;</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&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a0fd8da10042e0e7c97a74eef7f1fe413">ServiceL</a> (const RMessage2 &amp;aMessage)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server_session.html#a0fd8da10042e0e7c97a74eef7f1fe413">ServiceL</a> (const RMessage2 &amp;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> *&nbsp;</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> &amp;aServer)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> *&nbsp;</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> &amp;aServer)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> *&nbsp;</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> &amp;aServer)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server_session.html">CTimeServerSession</a> *&nbsp;</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> &amp;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 &amp; 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>&nbsp;)&nbsp;</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">&quot;fragment&quot;</span>&gt;&lt;pre <span class="keyword">class</span>=<span class="stringliteral">&quot;fragment&quot;</span>&gt;&lt;a name=<span class="stringliteral">&quot;l00122&quot;</span>&gt;&lt;/a&gt;00122     {
+&lt;a name=<span class="stringliteral">&quot;l00123&quot;</span>&gt;&lt;/a&gt;00123     &lt;a <span class="keyword">class</span>=<span class="stringliteral">&quot;code&quot;</span> href=<span class="stringliteral">&quot;class_c_time_server.html#40ac9219e4400c125719d767d564fc3e&quot;</span>&gt;iSessionCount&lt;/a&gt;--;
+&lt;a name=<span class="stringliteral">&quot;l00124&quot;</span>&gt;&lt;/a&gt;00124     &lt;span <span class="keyword">class</span>=<span class="stringliteral">&quot;keywordflow&quot;</span>&gt;<span class="keywordflow">if</span>&lt;/span&gt; ( &lt;a <span class="keyword">class</span>=<span class="stringliteral">&quot;code&quot;</span> href=<span class="stringliteral">&quot;class_c_time_server.html#40ac9219e4400c125719d767d564fc3e&quot;</span>&gt;iSessionCount&lt;/a&gt; &amp;lt;= 0 )
+&lt;a name=<span class="stringliteral">&quot;l00125&quot;</span>&gt;&lt;/a&gt;00125         {
+&lt;a name=<span class="stringliteral">&quot;l00126&quot;</span>&gt;&lt;/a&gt;00126         CActiveScheduler::Stop();
+&lt;a name=<span class="stringliteral">&quot;l00127&quot;</span>&gt;&lt;/a&gt;00127         }
+&lt;a name=<span class="stringliteral">&quot;l00128&quot;</span>&gt;&lt;/a&gt;00128     }
+&lt;/pre&gt;&lt;/div&gt;
+&lt;p&gt;
+    &lt;/td&gt;
+  &lt;/tr&gt;
+&lt;/table&gt;
+&lt;a <span class="keyword">class</span>=<span class="stringliteral">&quot;anchor&quot;</span> name=<span class="stringliteral">&quot;a8205372b5d379fa4b803e98b0726473&quot;</span>&gt;&lt;/a&gt;&lt;!-- doxytag: member=<span class="stringliteral">&quot;CTimeServer::WaitForTickL&quot;</span> ref=<span class="stringliteral">&quot;a8205372b5d379fa4b803e98b0726473&quot;</span> args=<span class="stringliteral">&quot;()&quot;</span> --&gt;&lt;p&gt;
+&lt;table <span class="keyword">class</span>=<span class="stringliteral">&quot;mdTable&quot;</span> cellpadding=<span class="stringliteral">&quot;2&quot;</span> cellspacing=<span class="stringliteral">&quot;0&quot;</span>&gt;
+  &lt;tr&gt;
+    &lt;td <span class="keyword">class</span>=<span class="stringliteral">&quot;mdRow&quot;</span>&gt;
+      &lt;table cellpadding=<span class="stringliteral">&quot;0&quot;</span> cellspacing=<span class="stringliteral">&quot;0&quot;</span> border=<span class="stringliteral">&quot;0&quot;</span>&gt;
+        &lt;tr&gt;
+          &lt;td <span class="keyword">class</span>=<span class="stringliteral">&quot;md&quot;</span> nowrap valign=<span class="stringliteral">&quot;top&quot;</span>&gt;<span class="keywordtype">void</span> <a class="code" href="class_c_time_server.html#a6787f6b173c59446b202ae04177a5d88">CTimeServer::WaitForTickL</a>           &lt;/td&gt;
+          &lt;td <span class="keyword">class</span>=<span class="stringliteral">&quot;md&quot;</span> valign=<span class="stringliteral">&quot;top&quot;</span>&gt;(&amp;nbsp;&lt;/td&gt;
+          &lt;td <span class="keyword">class</span>=<span class="stringliteral">&quot;mdname1&quot;</span> valign=<span class="stringliteral">&quot;top&quot;</span> nowrap&gt;          &lt;/td&gt;
+          &lt;td <span class="keyword">class</span>=<span class="stringliteral">&quot;md&quot;</span> valign=<span class="stringliteral">&quot;top&quot;</span>&gt;&amp;nbsp;)&amp;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>&nbsp;)&nbsp;</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 &amp;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> &amp;&nbsp;</td>
+          <td class="paramname"> <em>aServer</em></td>
+          <td>&nbsp;)&nbsp;</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>&nbsp;</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 &amp;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> &amp;&nbsp;</td>
+          <td class="paramname"> <em>aServer</em></td>
+          <td>&nbsp;)&nbsp;</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>&nbsp;</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>&nbsp;)&nbsp;</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 &amp;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 &amp;&nbsp;</td>
+          <td class="paramname"> <em>aMessage</em></td>
+          <td>&nbsp;)&nbsp;</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>&nbsp;</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 &amp;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> &amp;&nbsp;</td>
+          <td class="paramname"> <em>aServer</em></td>
+          <td>&nbsp;)&nbsp;</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>&nbsp;</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 &amp;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> &amp;&nbsp;</td>
+          <td class="paramname"> <em>aServer</em></td>
+          <td>&nbsp;)&nbsp;</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>&nbsp;</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 &amp;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 &amp;&nbsp;</td>
+          <td class="paramname"> <em>aMessage</em></td>
+          <td>&nbsp;)&nbsp;</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>&nbsp;</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&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>