Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_sec_engine.html
week 10 bug fix submission: Bug 1892, Bug 1897, Bug 1319. Also 3 or 4 documents were found to contain code blocks with SFL, which has been fixed. Partial fix for broken links, links to Forum Nokia, and the 'Symbian platform' terminology issues.
<!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: CSecEngine 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>CSecEngine Class Reference</h1><!-- doxytag: class="CSecEngine" -->
<p>
<a href="class_c_sec_engine-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sec_engine.html#5e11af23e18320c7c781c7250a0c25b1">~CSecEngine</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sec_engine.html#b13ef6e8b9c8b4de8c3e6748625c4bd5">ConnectL</a> (const <a class="el" href="struct_t_connect_settings.html">TConnectSettings</a> &aConnectSettings)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sec_engine.html#b1a5a2132c12cfc0d9a5fed49cb739c2">SetConsole</a> (CConsoleBase &aConsole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sec_engine.html#2d03d9e8d0822c833de323b54eb20c62">SetOutputFile</a> (RFile &aOutputFile)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sec_engine.html#137260c67a287dd2519efc99df880e5c">InUse</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_sec_engine.html">CSecEngine</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_sec_engine.html#28e68fc7a2fbb14f316dd9c1905d117c">NewL</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Manages connection to a SSL web server.
<p>Definition at line <a class="el" href="_sec_engine_8h-source.html#l00042">42</a> of file <a class="el" href="_sec_engine_8h-source.html">SecEngine.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5e11af23e18320c7c781c7250a0c25b1"></a><!-- doxytag: member="CSecEngine::~CSecEngine" ref="5e11af23e18320c7c781c7250a0c25b1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSecEngine::~CSecEngine </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>Definition at line <a class="el" href="_sec_engine_8cpp-source.html#l00069">69</a> of file <a class="el" href="_sec_engine_8cpp-source.html">SecEngine.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="28e68fc7a2fbb14f316dd9c1905d117c"></a><!-- doxytag: member="CSecEngine::NewL" ref="28e68fc7a2fbb14f316dd9c1905d117c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_sec_engine.html">CSecEngine</a> * CSecEngine::NewL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocates and constructs a new engine. <dl class="return" compact><dt><b>Returns:</b></dt><dd>New object </dd></dl>
<p>Definition at line <a class="el" href="_sec_engine_8cpp-source.html#l00053">53</a> of file <a class="el" href="_sec_engine_8cpp-source.html">SecEngine.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b13ef6e8b9c8b4de8c3e6748625c4bd5"></a><!-- doxytag: member="CSecEngine::ConnectL" ref="b13ef6e8b9c8b4de8c3e6748625c4bd5" args="(const TConnectSettings &aConnectSettings)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecEngine::ConnectL </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_t_connect_settings.html">TConnectSettings</a> & </td>
<td class="paramname"> <em>aConnectSettings</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initiates the connection to a server and the transaction<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aAddress</em> </td><td>Server address (e.g. www.nokia.com or dotted decimal format)</td></tr>
<tr><td valign="top"></td><td valign="top"><em>aPortNum</em> </td><td>Server port for secure web (e.g. 443)</td></tr>
<tr><td valign="top"></td><td valign="top"><em>aPage</em> </td><td>Web page to get from the server. The leading `/` should be included, e.g. /webpage.html.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCipherSuite</em> </td><td>Cipher suites that client will tell server it supports (decimal). This should be in decimal, with 2 characters, ie for suites 3,7,8,9, this field would be 03070809. By entering a single `0` for this field, the SSL default cipher suites will be passed.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCipher</em> </td><td>Cipher suite that server is expected to use (decimal). This is compared with actual cipher for pass/fail. If this field is 0, no comparisons with the actual cipher suite used will be made. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="_sec_engine_8cpp-source.html#l00097">97</a> of file <a class="el" href="_sec_engine_8cpp-source.html">SecEngine.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b1a5a2132c12cfc0d9a5fed49cb739c2"></a><!-- doxytag: member="CSecEngine::SetConsole" ref="b1a5a2132c12cfc0d9a5fed49cb739c2" args="(CConsoleBase &aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecEngine::SetConsole </td>
<td>(</td>
<td class="paramtype">CConsoleBase & </td>
<td class="paramname"> <em>aConsole</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the console to write messages to<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The console </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="_sec_engine_8cpp-source.html#l00139">139</a> of file <a class="el" href="_sec_engine_8cpp-source.html">SecEngine.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2d03d9e8d0822c833de323b54eb20c62"></a><!-- doxytag: member="CSecEngine::SetOutputFile" ref="2d03d9e8d0822c833de323b54eb20c62" args="(RFile &aOutputFile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSecEngine::SetOutputFile </td>
<td>(</td>
<td class="paramtype">RFile & </td>
<td class="paramname"> <em>aOutputFile</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the (opened) file to write server response to<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aOutputFile</em> </td><td>The file </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="_sec_engine_8cpp-source.html#l00144">144</a> of file <a class="el" href="_sec_engine_8cpp-source.html">SecEngine.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="137260c67a287dd2519efc99df880e5c"></a><!-- doxytag: member="CSecEngine::InUse" ref="137260c67a287dd2519efc99df880e5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CSecEngine::InUse </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tests if the connection is in progress.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if in progress else false </dd></dl>
<p>Definition at line <a class="el" href="_sec_engine_8cpp-source.html#l00149">149</a> of file <a class="el" href="_sec_engine_8cpp-source.html">SecEngine.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by
<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>