Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_time_server.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.html	Tue Mar 30 16:16:55 2010 +0100
@@ -0,0 +1,393 @@
+<!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: CTimeServer 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>CTimeServer Class Reference</h1><!-- doxytag: class="CTimeServer" --><!-- doxytag: inherits="CServer2,CServer2" -->
+<p>Inherits CServer2, and CServer2.</p>
+
+<p><a href="class_c_time_server-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.html#a877cb5a498a575353d12576272a99992">~CTimeServer</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.html#a9fb3c4c32d4050bc6f3b8ede0199bb7e">IncrementSessions</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.html#ad2b51a53e39f5844cce161bb912e0b7a">DecrementSessions</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.html#a6787f6b173c59446b202ae04177a5d88">WaitForTickL</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.html#aaf1149f0fedf24e384705ce734d6d7fe">Beat</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.html#adf49f002c1503eb70fb6e0e623ade0d8">Synchronize</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.html#a9fb3c4c32d4050bc6f3b8ede0199bb7e">IncrementSessions</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.html#ad2b51a53e39f5844cce161bb912e0b7a">DecrementSessions</a> ()</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.html">CTimeServer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#a59b4f2ad9c1b3a2c689b9ffa1cd11179">NewL</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server.html">CTimeServer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#a599b3712d5d1f6e9e2017508c689d2e5">NewLC</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#af9f826864fde246cd6c53af89563ba70">ThreadFunction</a> (TAny *aStarted)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server.html">CTimeServer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#ae1efa09cd586b02ebd5d3c82f5a421db">NewL</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_server.html">CTimeServer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#a56240a29754fdbe1610aa2ac73338474">NewLC</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#aa06c28ceaded3b71432ef76cecbbd46e">ThreadFunction</a> (TAny *aNone)</td></tr>
+<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#a0f86707c23aa97a861ca8fe8e239194c">RunError</a> (TInt aError)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_server.html#a0f86707c23aa97a861ca8fe8e239194c">RunError</a> (TInt aError)</td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p><a class="el" href="class_c_time_server.html">CTimeServer</a>. An instance of class <a class="el" href="class_c_time_server.html">CTimeServer</a> is the main server class for the ClientServerAsync example application.</p>
+<p><a class="el" href="class_c_time_server.html">CTimeServer</a>. An instance of class <a class="el" href="class_c_time_server.html">CTimeServer</a> is the main server class for the ClientServerSync example application </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2inc_2timeserver_8h_source.html#l00030">30</a> of file <a class="el" href="_client_server_async_2server_2inc_2timeserver_8h_source.html">timeserver.h</a>.</p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a877cb5a498a575353d12576272a99992"></a><!-- doxytag: member="CTimeServer::~CTimeServer" ref="a877cb5a498a575353d12576272a99992" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">CTimeServer::~CTimeServer </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>~CTimeServer. Destructor. </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00078">78</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a59b4f2ad9c1b3a2c689b9ffa1cd11179"></a><!-- doxytag: member="CTimeServer::NewL" ref="a59b4f2ad9c1b3a2c689b9ffa1cd11179" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="class_c_time_server.html">CTimeServer</a> * CTimeServer::NewL </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>NewL. Two-phased constructor. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server.html">CTimeServer</a> object. </dd></dl>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00032">32</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a599b3712d5d1f6e9e2017508c689d2e5"></a><!-- doxytag: member="CTimeServer::NewLC" ref="a599b3712d5d1f6e9e2017508c689d2e5" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="class_c_time_server.html">CTimeServer</a> * CTimeServer::NewLC </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>NewLC. Two-phased constructor. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server.html">CTimeServer</a> object. </dd></dl>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00044">44</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="af9f826864fde246cd6c53af89563ba70"></a><!-- doxytag: member="CTimeServer::ThreadFunction" ref="af9f826864fde246cd6c53af89563ba70" args="(TAny *aStarted)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">TInt CTimeServer::ThreadFunction </td>
+          <td>(</td>
+          <td class="paramtype">TAny *&nbsp;</td>
+          <td class="paramname"> <em>aStarted</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>ThreadFunction. Main function for the server thread. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>aStarted</em>&nbsp;</td><td>A semaphore to be flagged when server has been started. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00264">264</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a9fb3c4c32d4050bc6f3b8ede0199bb7e"></a><!-- doxytag: member="CTimeServer::IncrementSessions" ref="a9fb3c4c32d4050bc6f3b8ede0199bb7e" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::IncrementSessions </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>IncrementSessions. Increments the count of the active sessions for this server. </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00111">111</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ad2b51a53e39f5844cce161bb912e0b7a"></a><!-- doxytag: member="CTimeServer::DecrementSessions" ref="ad2b51a53e39f5844cce161bb912e0b7a" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::DecrementSessions </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>DecrementSessions. Decrements the count of the active sessions for this server. If no more sessions are in use the server terminates. </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00121">121</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a6787f6b173c59446b202ae04177a5d88"></a><!-- doxytag: member="CTimeServer::WaitForTickL" ref="a6787f6b173c59446b202ae04177a5d88" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::WaitForTickL </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>WaitForTickL. Activates the heartbeat. </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00181">181</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="aaf1149f0fedf24e384705ce734d6d7fe"></a><!-- doxytag: member="CTimeServer::Beat" ref="aaf1149f0fedf24e384705ce734d6d7fe" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::Beat </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>From MBeating, Beat. A clock tick has occured. </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00195">195</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="adf49f002c1503eb70fb6e0e623ade0d8"></a><!-- doxytag: member="CTimeServer::Synchronize" ref="adf49f002c1503eb70fb6e0e623ade0d8" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::Synchronize </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>From MBeating, Synchronize. Several clock ticks have occured. </p>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00205">205</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a0f86707c23aa97a861ca8fe8e239194c"></a><!-- doxytag: member="CTimeServer::RunError" ref="a0f86707c23aa97a861ca8fe8e239194c" args="(TInt aError)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">TInt CTimeServer::RunError </td>
+          <td>(</td>
+          <td class="paramtype">TInt&nbsp;</td>
+          <td class="paramname"> <em>aError</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>From CActive, RunError. Processes any errors. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>aError</em>&nbsp;</td><td>The leave code reported. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>return KErrNone if leave is handled. </dd></dl>
+
+<p>Definition at line <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html#l00135">135</a> of file <a class="el" href="_client_server_async_2server_2src_2timeserver_8cpp_source.html">timeserver.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ae1efa09cd586b02ebd5d3c82f5a421db"></a><!-- doxytag: member="CTimeServer::NewL" ref="ae1efa09cd586b02ebd5d3c82f5a421db" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">static <a class="el" href="class_c_time_server.html">CTimeServer</a>* CTimeServer::NewL </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>NewL. Two-phased constructor. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server.html">CTimeServer</a> object. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a56240a29754fdbe1610aa2ac73338474"></a><!-- doxytag: member="CTimeServer::NewLC" ref="a56240a29754fdbe1610aa2ac73338474" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">static <a class="el" href="class_c_time_server.html">CTimeServer</a>* CTimeServer::NewLC </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>NewLC. Two-phased constructor. </p>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to created <a class="el" href="class_c_time_server.html">CTimeServer</a> object. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="aa06c28ceaded3b71432ef76cecbbd46e"></a><!-- doxytag: member="CTimeServer::ThreadFunction" ref="aa06c28ceaded3b71432ef76cecbbd46e" args="(TAny *aNone)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">static TInt CTimeServer::ThreadFunction </td>
+          <td>(</td>
+          <td class="paramtype">TAny *&nbsp;</td>
+          <td class="paramname"> <em>aNone</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>ThreadFunction. Main function for the server thread. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>aNone</em>&nbsp;</td><td>Not used. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Error code. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a9fb3c4c32d4050bc6f3b8ede0199bb7e"></a><!-- doxytag: member="CTimeServer::IncrementSessions" ref="a9fb3c4c32d4050bc6f3b8ede0199bb7e" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::IncrementSessions </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>IncrementSessions. Increments the count of the active sessions for this server. </p>
+
+</div>
+</div>
+<a class="anchor" id="ad2b51a53e39f5844cce161bb912e0b7a"></a><!-- doxytag: member="CTimeServer::DecrementSessions" ref="ad2b51a53e39f5844cce161bb912e0b7a" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CTimeServer::DecrementSessions </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>DecrementSessions. Decrements the count of the active sessions for this server. If no more sessions are in use the server terminates. </p>
+
+</div>
+</div>
+<a class="anchor" id="a0f86707c23aa97a861ca8fe8e239194c"></a><!-- doxytag: member="CTimeServer::RunError" ref="a0f86707c23aa97a861ca8fe8e239194c" args="(TInt aError)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">TInt CTimeServer::RunError </td>
+          <td>(</td>
+          <td class="paramtype">TInt&nbsp;</td>
+          <td class="paramname"> <em>aError</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [protected]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>From CActive, RunError. Processes any errors. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>aError</em>&nbsp;</td><td>The leave code reported. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>return KErrNone if leave is handled. </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>