Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_secure_server_sub_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: CSecureServerSubSession 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>CSecureServerSubSession Class Reference</h1><!-- doxytag: class="CSecureServerSubSession" -->
<p><a href="class_c_secure_server_sub_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_secure_server_sub_session.html#a5303b3bc024108cd70a7f331e2052672">CSecureServerSubSession</a> (<a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> *aSession)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa89c8f9b580dd39f8f9820e59b1f20cf"></a><!-- doxytag: member="CSecureServerSubSession::ConstructL" ref="aa89c8f9b580dd39f8f9820e59b1f20cf" args="(CSecureServerSession *aSession)" -->
void </td><td class="memItemRight" valign="bottom"><b>ConstructL</b> (<a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> *aSession)</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_sub_session.html#a97ed872aae87b8cb76d6fa101a52303f">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_secure_server_sub_session.html#a388299f02880acd81521b12ea68fb6ba">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_secure_server_sub_session.html#a2de0131772c586accbd61fb2ed329647">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_secure_server_sub_session.html#ac9e4188e16b286e4ed6cbd1cce24a42e">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_secure_server_sub_session.html#aaee3504a264b7c7136660201bf143a6d">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_secure_server_sub_session.html#a5ffe759ade87ebaeea7e2399d65b07e5">Reset</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_sub_session.html#a3edaea36ff8bb03d5814b4aa245b761a">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_secure_server_sub_session.html#a5a58cd7db75221072f5ef4251fe75a82">SaveCounterValueL</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_sub_session.html#a234065b99df276eca6097ab3d89cc81a">SetCounterValueFromFileL</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="abd692ce94929d4498b481acebff4f669"></a><!-- doxytag: member="CSecureServerSubSession::NewL" ref="abd692ce94929d4498b481acebff4f669" args="(CSecureServerSession *aSession)" -->
static <a class="el" href="class_c_secure_server_sub_session.html">CSecureServerSubSession</a> * </td><td class="memItemRight" valign="bottom"><b>NewL</b> (<a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> *aSession)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_sub_session.html#a12f71f6ef1769cfe3f98606e0d11ae41">iSession</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The class that represents a subsession. When a client wants more than one connection to a server at the same time, it can use a subsession. A subsession is more efficient than a session, but an application needs to provide more code. A subsession object is created by a session. A session can own any number of subsession objects. The class provides functions that respond to client messages. </p>
<p>Definition at line <a class="el" href="secureserver_8h_source.html#l00256">256</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="a5303b3bc024108cd70a7f331e2052672"></a><!-- doxytag: member="CSecureServerSubSession::CSecureServerSubSession" ref="a5303b3bc024108cd70a7f331e2052672" args="(CSecureServerSession *aSession)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSecureServerSubSession::CSecureServerSubSession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> * </td>
<td class="paramname"> <em>aSession</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor of the <a class="el" href="class_c_secure_server_sub_session.html">CSecureServerSubSession</a> class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSession</em> </td><td>The session to which this subsession is to be attached. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a> </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00030">30</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a97ed872aae87b8cb76d6fa101a52303f"></a><!-- doxytag: member="CSecureServerSubSession::SetFromStringL" ref="a97ed872aae87b8cb76d6fa101a52303f" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::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>Sets the counter value from a string. </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>Message that encapsulates the string sent by the client. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00038">38</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a388299f02880acd81521b12ea68fb6ba"></a><!-- doxytag: member="CSecureServerSubSession::Increase" ref="a388299f02880acd81521b12ea68fb6ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::Increase </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increases the counter value by one. </p>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00077">77</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2de0131772c586accbd61fb2ed329647"></a><!-- doxytag: member="CSecureServerSubSession::IncreaseBy" ref="a2de0131772c586accbd61fb2ed329647" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::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 counter value by the value passed in the 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 value sent by the client. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_r_secure_sub_session.html#aa33648763c953202fb21f037b2d413e9">RSecureSubSession::Increase()</a> </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00087">87</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac9e4188e16b286e4ed6cbd1cce24a42e"></a><!-- doxytag: member="CSecureServerSubSession::Decrease" ref="ac9e4188e16b286e4ed6cbd1cce24a42e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::Decrease </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decreases the counter value by one. </p>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00095">95</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaee3504a264b7c7136660201bf143a6d"></a><!-- doxytag: member="CSecureServerSubSession::DecreaseBy" ref="aaee3504a264b7c7136660201bf143a6d" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::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 counter value by the value passed in the 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 value sent by the client. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_r_secure_sub_session.html#a398e6146ebf438ee1f0b24c77b5b767c">RSecureSubSession::Decrease()</a> </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00105">105</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5ffe759ade87ebaeea7e2399d65b07e5"></a><!-- doxytag: member="CSecureServerSubSession::Reset" ref="a5ffe759ade87ebaeea7e2399d65b07e5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::Reset </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the counter to 0. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_r_secure_sub_session.html#a9ce8394ea263eaba7f462bc2fdc62127">RSecureSubSession::Reset()</a> </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00114">114</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3edaea36ff8bb03d5814b4aa245b761a"></a><!-- doxytag: member="CSecureServerSubSession::CounterValueL" ref="a3edaea36ff8bb03d5814b4aa245b761a" args="(const RMessage2 &aMessage)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::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>Sends the counter value to 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 that encapsulates the counter value sent to the client by the server. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00123">123</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5a58cd7db75221072f5ef4251fe75a82"></a><!-- doxytag: member="CSecureServerSubSession::SaveCounterValueL" ref="a5a58cd7db75221072f5ef4251fe75a82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::SaveCounterValueL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Saves the counter value in the file counter.dat.</p>
<p>The example creates the file in the private directory of the executable process. The private directory is created on a device’s system drive. This is the drive that a device marks as the standard place for application data.</p>
<p>In this example, this is the location: C:.dat</p>
<p>0x70fffff0 is the Secure ID (SID) of the process; this is defined in <a class="el" href="secureclient_8mmp_source.html">secureclient.mmp</a>.</p>
<p>C: is the system drive. When built and run on the emulator, see …\...:\... </p>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00142">142</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a234065b99df276eca6097ab3d89cc81a"></a><!-- doxytag: member="CSecureServerSubSession::SetCounterValueFromFileL" ref="a234065b99df276eca6097ab3d89cc81a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecureServerSubSession::SetCounterValueFromFileL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the counter value from the file counter.dat. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_c_secure_server_sub_session.html#a5a58cd7db75221072f5ef4251fe75a82">CSecureServerSubSession::SaveCounterValueL()</a> </dd></dl>
<p>Definition at line <a class="el" href="secureserverccountsubsession_8cpp_source.html#l00175">175</a> of file <a class="el" href="secureserverccountsubsession_8cpp_source.html">secureserverccountsubsession.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a12f71f6ef1769cfe3f98606e0d11ae41"></a><!-- doxytag: member="CSecureServerSubSession::iSession" ref="a12f71f6ef1769cfe3f98606e0d11ae41" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a>* <a class="el" href="class_c_secure_server_sub_session.html#a12f71f6ef1769cfe3f98606e0d11ae41">CSecureServerSubSession::iSession</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The parent session. </p>
<p>Definition at line <a class="el" href="secureserver_8h_source.html#l00276">276</a> of file <a class="el" href="secureserver_8h_source.html">secureserver.h</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>