Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_count_session.html
author Dominic Pinkman <Dominic.Pinkman@Nokia.com>
Tue, 30 Mar 2010 11:42:04 +0100
changeset 4 4816d766a08a
parent 1 25a17d01db0c
permissions -rw-r--r--
Week 12 contribution of SDK documentation_content. See release notes for details. Fixes Bug 1892, Bug 1522, Bug 1520, Bug 394, Bug 1319, Bug 344, Bug 1897

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: RCountSession Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>RCountSession Class Reference</h1><!-- doxytag: class="RCountSession" -->
<p>
<a href="class_r_count_session-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_count_session.html#7295a2ee03f848825201d5b1e9851f6b">RCountSession</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_count_session.html#cd29db0e4420ca6ae6c8b8097ef74db5">Connect</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">TVersion&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_count_session.html#1a9b9934faa988767ac3d7546f27f485">Version</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_count_session.html#a0c3f5f48536d904c20f5f65e8fa847a">ResourceCount</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_count_session.html#d773246941374f366b767907678ddf1d">Close</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="class_r_count_session.html">RCountSession</a><p>
The client-side handle to a session with the server, The class forms a layer over the Symbian provided RSessionBase class.<p>
The class deals with the requests made by the main example code by forwarding them to the server. The type of request is identified by a code, one of the TCountServRqst enum values, and arguments are passed via a TIpcArgs object. 
<p>Definition at line <a class="el" href="_complex_client_8h-source.html#l00032">32</a> of file <a class="el" href="_complex_client_8h-source.html">ComplexClient.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="7295a2ee03f848825201d5b1e9851f6b"></a><!-- doxytag: member="RCountSession::RCountSession" ref="7295a2ee03f848825201d5b1e9851f6b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">RCountSession::RCountSession           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor 
<p>Definition at line <a class="el" href="_complex_client_session_8cpp-source.html#l00029">29</a> of file <a class="el" href="_complex_client_session_8cpp-source.html">ComplexClientSession.cpp</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cd29db0e4420ca6ae6c8b8097ef74db5"></a><!-- doxytag: member="RCountSession::Connect" ref="cd29db0e4420ca6ae6c8b8097ef74db5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TInt RCountSession::Connect           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Connects to the server using 4 message slots.<p>
In this example, the server is implemented as a separate thread. The function starts that thread before attempting to create a session with the server.<p>
The version information specifies the earliest version of the server that we can talk to. 
<p>Definition at line <a class="el" href="_complex_client_session_8cpp-source.html#l00043">43</a> of file <a class="el" href="_complex_client_session_8cpp-source.html">ComplexClientSession.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="1a9b9934faa988767ac3d7546f27f485"></a><!-- doxytag: member="RCountSession::Version" ref="1a9b9934faa988767ac3d7546f27f485" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TVersion RCountSession::Version           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the earliest version number of the server that we can talk to. 
<p>Definition at line <a class="el" href="_complex_client_session_8cpp-source.html#l00055">55</a> of file <a class="el" href="_complex_client_session_8cpp-source.html">ComplexClientSession.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="a0c3f5f48536d904c20f5f65e8fa847a"></a><!-- doxytag: member="RCountSession::ResourceCount" ref="a0c3f5f48536d904c20f5f65e8fa847a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TInt RCountSession::ResourceCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A server request to get the number of subsessions in this session. 
<p>Definition at line <a class="el" href="_complex_client_session_8cpp-source.html#l00079">79</a> of file <a class="el" href="_complex_client_session_8cpp-source.html">ComplexClientSession.cpp</a>.</p>

</div>
</div><p>
<a class="anchor" name="d773246941374f366b767907678ddf1d"></a><!-- doxytag: member="RCountSession::Close" ref="d773246941374f366b767907678ddf1d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RCountSession::Close           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A request to close the session.<p>
It makes a call to the server, which deletes the object container and object index for this session, before calling <a class="el" href="class_r_count_session.html#d773246941374f366b767907678ddf1d">Close()</a> on the base class. 
<p>Definition at line <a class="el" href="_complex_client_session_8cpp-source.html#l00067">67</a> of file <a class="el" href="_complex_client_session_8cpp-source.html">ComplexClientSession.cpp</a>.</p>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>