Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_secure_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: CSecureServerSession 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>CSecureServerSession Class Reference</h1><!-- doxytag: class="CSecureServerSession" --><!-- doxytag: inherits="CSession2" -->
<p>Inherits CSession2.</p>
<p><a href="class_c_secure_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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#ab9502afe61e2be236b5602af41ff234d">CreateL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#a1ef8c62f2085e8e860a9d4333a354a4c">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_secure_server_session.html#a7f1276a074d2f92b29b924903a02f6bf">NewCounterL</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_secure_server_session.html#a5921d8c81a8a2e3c01f73a5ea23cc194">CloseSession</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#a4046b0fbcbf22d3aab8b2877cd554395">NumResourcesL</a> (const RMessage2 &aMessage)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_secure_server_sub_session.html">CSecureServerSubSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#a478b6424b1ab3dde2b874847164650f0">CounterFromHandle</a> (const RMessage2 &aMessage, TInt aHandle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#a879e7d197ab62104e2187e98ed2724b4">DeleteCounter</a> (TInt aHandle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#a0307c128da103c5fa6b9f5b382f90e3c">CountResources</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#a05f576bc35402465caafc65ad0593e8b">PanicClient</a> (const RMessage2 &aMessage, TInt aPanic) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html#ad02090d242cef53516c5680c97843b68">CSecureServerSession</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa870b15fee351872fba8466d4668802d"></a><!-- doxytag: member="CSecureServerSession::NewL" ref="aa870b15fee351872fba8466d4668802d" args="()" -->
static <a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> * </td><td class="memItemRight" valign="bottom"><b>NewL</b> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The class that represents a session with the server. When a client connects to the server, a session object is created by the server. The class provides functions that respond to client messages. A session can own any number of subsession objects. </p>
<p>Definition at line <a class="el" href="secureserver_8h_source.html#l00220">220</a> of file <a class="el" href="secureserver_8h_source.html">secureserver.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad02090d242cef53516c5680c97843b68"></a><!-- doxytag: member="CSecureServerSession::CSecureServerSession" ref="ad02090d242cef53516c5680c97843b68" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSecureServerSession::CSecureServerSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor of the <a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> class. </p>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00028">28</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab9502afe61e2be236b5602af41ff234d"></a><!-- doxytag: member="CSecureServerSession::CreateL" ref="ab9502afe61e2be236b5602af41ff234d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::CreateL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates the object index and object container for the session. </p>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00035">35</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1ef8c62f2085e8e860a9d4333a354a4c"></a><!-- doxytag: member="CSecureServerSession::ServiceL" ref="a1ef8c62f2085e8e860a9d4333a354a4c" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::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>Handles the servicing of a client request that has been passed to the server. This function dispatches requests to the appropriate handler. Some messages are handled by the session itself, and are implemented as <a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> member functions. Other messages are handled by the subsession, and are implemented as <a class="el" href="class_c_secure_server_sub_session.html">CSecureServerSubSession</a> member functions. Note that the server calls this function after a client request has passed the security checks. </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>The message containing the details of the client request. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00077">77</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7f1276a074d2f92b29b924903a02f6bf"></a><!-- doxytag: member="CSecureServerSession::NewCounterL" ref="a7f1276a074d2f92b29b924903a02f6bf" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::NewCounterL </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>Creates a new sub session for the current session. </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>The message containing the details of the client request. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00149">149</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5921d8c81a8a2e3c01f73a5ea23cc194"></a><!-- doxytag: member="CSecureServerSession::CloseSession" ref="a5921d8c81a8a2e3c01f73a5ea23cc194" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::CloseSession </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the session. This function deletes the object index and object container. </p>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00045">45</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4046b0fbcbf22d3aab8b2877cd554395"></a><!-- doxytag: member="CSecureServerSession::NumResourcesL" ref="a4046b0fbcbf22d3aab8b2877cd554395" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::NumResourcesL </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>Returns the resource count to the client by writing the resource count value into the client message. </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>The message containing the details of the client request. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00192">192</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a478b6424b1ab3dde2b874847164650f0"></a><!-- doxytag: member="CSecureServerSession::CounterFromHandle" ref="a478b6424b1ab3dde2b874847164650f0" args="(const RMessage2 &aMessage, TInt aHandle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_secure_server_sub_session.html">CSecureServerSubSession</a> * CSecureServerSession::CounterFromHandle </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>aHandle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the appropriate CCountSubSession object given a client's sub session handle. </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>The request message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aHandle</em> </td><td>Client's sub session handle. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The CCountSubSession object. </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00059">59</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a879e7d197ab62104e2187e98ed2724b4"></a><!-- doxytag: member="CSecureServerSession::DeleteCounter" ref="a879e7d197ab62104e2187e98ed2724b4" args="(TInt aHandle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::DeleteCounter </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aHandle</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deletes the sub session object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aHandle</em> </td><td>The handle to the sub session object. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00172">172</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0307c128da103c5fa6b9f5b382f90e3c"></a><!-- doxytag: member="CSecureServerSession::CountResources" ref="a0307c128da103c5fa6b9f5b382f90e3c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CSecureServerSession::CountResources </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the number of resources held by the session. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of resources held by the session. </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00183">183</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a05f576bc35402465caafc65ad0593e8b"></a><!-- doxytag: member="CSecureServerSession::PanicClient" ref="a05f576bc35402465caafc65ad0593e8b" args="(const RMessage2 &aMessage, TInt aPanic) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSession::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</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Panics the 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>The message containing the details of the client request. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aPanic</em> </td><td>The reason for the panic. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsession_8cpp_source.html#l00203">203</a> of file <a class="el" href="secureserverccountsession_8cpp_source.html">secureserverccountsession.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>