Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_secure_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: RSecureSubSession 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>RSecureSubSession Class Reference</h1><!-- doxytag: class="RSecureSubSession" --><!-- doxytag: inherits="RSubSessionBase" -->
<p>Inherits RSubSessionBase.</p>
<p><a href="class_r_secure_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">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#a490095bd4d40f65ea15f14d5fe481b71">Open</a> (<a class="el" href="class_r_secure_session.html">RSecureSession</a> &aServer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#af5aeec70e2056cbbeb64141573ff8f2c">SetFromString</a> (const TDesC &aString)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#aac12680343af53cd4737699847905cb9">Close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#aa33648763c953202fb21f037b2d413e9">Increase</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#a398e6146ebf438ee1f0b24c77b5b767c">Decrease</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#a9342022cfba8bec8db374364fc08fab6">IncreaseByL</a> (TInt anInt)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#a1cc1a1a8ecfb898713f681cfe76701cb">DecreaseByL</a> (TInt anInt)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#a9ce8394ea263eaba7f462bc2fdc62127">Reset</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#af205b880df310c24f47ce91ca6261a1d">CounterValueL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a2e415adf478eab70a70de4dd84d874"></a><!-- doxytag: member="RSecureSubSession::VerifyTransaction" ref="a1a2e415adf478eab70a70de4dd84d874" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>VerifyTransaction</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#a97d7a09b2347f1ef4f476feaaaa5f781">SaveCounterL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_secure_sub_session.html#ab9758c1131b23ed928fadee2a959e23e">SetCounterFromFileL</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The client-side handle to a subsession with the server. The class forms a layer over the Symbian provided RSubSessionBase class. The main example code calls member functions in this class to make requests to the server. The class forwards the requests to the server through the session. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_r_secure_session.html">RSecureSession</a> </dd></dl>
<p>Definition at line <a class="el" href="secureclient_8h_source.html#l00052">52</a> of file <a class="el" href="secureclient_8h_source.html">secureclient.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a490095bd4d40f65ea15f14d5fe481b71"></a><!-- doxytag: member="RSecureSubSession::Open" ref="a490095bd4d40f65ea15f14d5fe481b71" args="(RSecureSession &aServer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RSecureSubSession::Open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_r_secure_session.html">RSecureSession</a> & </td>
<td class="paramname"> <em>aSession</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a sub session and returns a handle to it. </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 handle. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the system-wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00031">31</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af5aeec70e2056cbbeb64141573ff8f2c"></a><!-- doxytag: member="RSecureSubSession::SetFromString" ref="af5aeec70e2056cbbeb64141573ff8f2c" args="(const TDesC &aString)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RSecureSubSession::SetFromString </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aString</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>aString</em> </td><td>The descriptor containing the counter value. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the system-wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00049">49</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aac12680343af53cd4737699847905cb9"></a><!-- doxytag: member="RSecureSubSession::Close" ref="aac12680343af53cd4737699847905cb9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::Close </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the sub session. </p>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00039">39</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa33648763c953202fb21f037b2d413e9"></a><!-- doxytag: member="RSecureSubSession::Increase" ref="aa33648763c953202fb21f037b2d413e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::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="secureclientsubsession_8cpp_source.html#l00058">58</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a398e6146ebf438ee1f0b24c77b5b767c"></a><!-- doxytag: member="RSecureSubSession::Decrease" ref="a398e6146ebf438ee1f0b24c77b5b767c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::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="secureclientsubsession_8cpp_source.html#l00082">82</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9342022cfba8bec8db374364fc08fab6"></a><!-- doxytag: member="RSecureSubSession::IncreaseByL" ref="a9342022cfba8bec8db374364fc08fab6" args="(TInt anInt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::IncreaseByL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aInt</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increases the counter value by the supplied value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aInt</em> </td><td>The increase in the counter value. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00070">70</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1cc1a1a8ecfb898713f681cfe76701cb"></a><!-- doxytag: member="RSecureSubSession::DecreaseByL" ref="a1cc1a1a8ecfb898713f681cfe76701cb" args="(TInt anInt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::DecreaseByL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aInt</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decreases the counter value by the supplied value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aInt</em> </td><td>The decrease in the counter value. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00094">94</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9ce8394ea263eaba7f462bc2fdc62127"></a><!-- doxytag: member="RSecureSubSession::Reset" ref="a9ce8394ea263eaba7f462bc2fdc62127" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::Reset </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the counter to zero. </p>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00106">106</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af205b880df310c24f47ce91ca6261a1d"></a><!-- doxytag: member="RSecureSubSession::CounterValueL" ref="af205b880df310c24f47ce91ca6261a1d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt RSecureSubSession::CounterValueL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the value of the counter. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The counter value. </dd></dl>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00118">118</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a97d7a09b2347f1ef4f476feaaaa5f781"></a><!-- doxytag: member="RSecureSubSession::SaveCounterL" ref="a97d7a09b2347f1ef4f476feaaaa5f781" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::SaveCounterL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Saves the counter value to 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="secureclientsubsession_8cpp_source.html#l00136">136</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab9758c1131b23ed928fadee2a959e23e"></a><!-- doxytag: member="RSecureSubSession::SetCounterFromFileL" ref="ab9758c1131b23ed928fadee2a959e23e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RSecureSubSession::SetCounterFromFileL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the counter to the value read 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#a234065b99df276eca6097ab3d89cc81a">CSecureServerSubSession::SetCounterValueFromFileL()</a> </dd></dl>
<p>Definition at line <a class="el" href="secureclientsubsession_8cpp_source.html#l00148">148</a> of file <a class="el" href="secureclientsubsession_8cpp_source.html">secureclientsubsession.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>