Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_count_serv_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: CCountServSession 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>CCountServSession Class Reference</h1><!-- doxytag: class="CCountServSession" --><!-- doxytag: inherits="CSession2" -->
<p>Inherits CSession2.</p>
<p><a href="class_c_count_serv_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_c_count_serv_session.html#ac68abcf96df46d35d7b42daef3373a7e">CCountServSession</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#ad339aa53d99cf7e1fe2584ccc523eade">ServiceL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a0c22651f5af66827c00baab5ad0c697e">DispatchMessageL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a4525c4f71d949a86fe4c02a7b242ce1e">SetFromStringL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a26b884886f050963b5c29b792131418d">Increase</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#aeaeb91138f6d418a4fa580e095ed6081">Decrease</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a36a92a040c8531527ae6de25ee1a1299">IncreaseBy</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#ab3a11addfd25b34b31ec7537d2e389af">DecreaseBy</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a1c4cd0dd8c2cab784c4e3fafea9e4115">CounterValueL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a11afb27d6b3cfb6b658c46e3f5d1bd22">Reset</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_serv_session.html#a136ce24bef4184ad3b61aa9ae4bca5e0">PanicClient</a> (const RMessage2 &aMessage, TInt aPanic) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents a session with the server. Functions are provided to respond appropriately to client messages. </p>
<p>Definition at line <a class="el" href="_simple_server_8h_source.html#l00068">68</a> of file <a class="el" href="_simple_server_8h_source.html">SimpleServer.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac68abcf96df46d35d7b42daef3373a7e"></a><!-- doxytag: member="CCountServSession::CCountServSession" ref="ac68abcf96df46d35d7b42daef3373a7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCountServSession::CCountServSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00085">85</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad339aa53d99cf7e1fe2584ccc523eade"></a><!-- doxytag: member="CCountServSession::ServiceL" ref="ad339aa53d99cf7e1fe2584ccc523eade" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::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>Services a client request. </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00092">92</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0c22651f5af66827c00baab5ad0c697e"></a><!-- doxytag: member="CCountServSession::DispatchMessageL" ref="a0c22651f5af66827c00baab5ad0c697e" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::DispatchMessageL </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>Called by <a class="el" href="class_c_count_serv_session.html#ad339aa53d99cf7e1fe2584ccc523eade">ServiceL()</a></p>
<p>It tests the function code and then delegates to the appropriate function. </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00104">104</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4525c4f71d949a86fe4c02a7b242ce1e"></a><!-- doxytag: member="CCountServSession::SetFromStringL" ref="a4525c4f71d949a86fe4c02a7b242ce1e" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::SetFromStringL </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>Initialize the counter with the numeric equivalent of the descriptor contents This function is here to demonstrate reading from the client address space. Note that in this example, the client and the server are part of the same process, </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00149">149</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a26b884886f050963b5c29b792131418d"></a><!-- doxytag: member="CCountServSession::Increase" ref="a26b884886f050963b5c29b792131418d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::Increase </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increases the session counter by default (1) </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00203">203</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aeaeb91138f6d418a4fa580e095ed6081"></a><!-- doxytag: member="CCountServSession::Decrease" ref="aeaeb91138f6d418a4fa580e095ed6081" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::Decrease </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decreases the session counter by default (1) </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00220">220</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a36a92a040c8531527ae6de25ee1a1299"></a><!-- doxytag: member="CCountServSession::IncreaseBy" ref="a36a92a040c8531527ae6de25ee1a1299" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::IncreaseBy </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>Increases the session counter by an integer. </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00212">212</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab3a11addfd25b34b31ec7537d2e389af"></a><!-- doxytag: member="CCountServSession::DecreaseBy" ref="ab3a11addfd25b34b31ec7537d2e389af" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::DecreaseBy </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>Decreases the session counter by an integer. </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00229">229</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1c4cd0dd8c2cab784c4e3fafea9e4115"></a><!-- doxytag: member="CCountServSession::CounterValueL" ref="a1c4cd0dd8c2cab784c4e3fafea9e4115" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::CounterValueL </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>Writes the counter value to a descriptor in the client address space. This function demonstrates writing to the client. </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00248">248</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a11afb27d6b3cfb6b658c46e3f5d1bd22"></a><!-- doxytag: member="CCountServSession::Reset" ref="a11afb27d6b3cfb6b658c46e3f5d1bd22" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::Reset </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the session counter. </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00238">238</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a136ce24bef4184ad3b61aa9ae4bca5e0"></a><!-- doxytag: member="CCountServSession::PanicClient" ref="a136ce24bef4184ad3b61aa9ae4bca5e0" args="(const RMessage2 &aMessage, TInt aPanic) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCountServSession::PanicClient </td>
<td>(</td>
<td class="paramtype">const RMessage2 & </td>
<td class="paramname"> <em>aMessage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aPanic</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Panics the client </p>
<p>Definition at line <a class="el" href="_simple_server_8cpp_source.html#l00258">258</a> of file <a class="el" href="_simple_server_8cpp_source.html">SimpleServer.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>