|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
|
3 <title>TB10.1 Example Applications: CSecEngine Class Reference</title> |
|
4 <link href="doxygen.css" rel="stylesheet" type="text/css"> |
|
5 <link href="tabs.css" rel="stylesheet" type="text/css"> |
|
6 </head><body> |
|
7 <!-- Generated by Doxygen 1.5.3 --> |
|
8 <h1>CSecEngine Class Reference</h1><!-- doxytag: class="CSecEngine" --> |
|
9 <p> |
|
10 <a href="class_c_sec_engine-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
11 <tr><td></td></tr> |
|
12 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
|
13 <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> |
|
14 |
|
15 <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> |
|
16 |
|
17 <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> |
|
18 |
|
19 <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> |
|
20 |
|
21 <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> |
|
22 |
|
23 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
|
24 <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> |
|
25 |
|
26 </table> |
|
27 <hr><a name="_details"></a><h2>Detailed Description</h2> |
|
28 Manages connection to a SSL web server. |
|
29 <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> |
|
30 <hr><h2>Constructor & Destructor Documentation</h2> |
|
31 <a class="anchor" name="5e11af23e18320c7c781c7250a0c25b1"></a><!-- doxytag: member="CSecEngine::~CSecEngine" ref="5e11af23e18320c7c781c7250a0c25b1" args="()" --> |
|
32 <div class="memitem"> |
|
33 <div class="memproto"> |
|
34 <table class="memname"> |
|
35 <tr> |
|
36 <td class="memname">CSecEngine::~CSecEngine </td> |
|
37 <td>(</td> |
|
38 <td class="paramname"> </td> |
|
39 <td> ) </td> |
|
40 <td width="100%"></td> |
|
41 </tr> |
|
42 </table> |
|
43 </div> |
|
44 <div class="memdoc"> |
|
45 |
|
46 <p> |
|
47 Destructor. |
|
48 <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> |
|
49 |
|
50 </div> |
|
51 </div><p> |
|
52 <hr><h2>Member Function Documentation</h2> |
|
53 <a class="anchor" name="28e68fc7a2fbb14f316dd9c1905d117c"></a><!-- doxytag: member="CSecEngine::NewL" ref="28e68fc7a2fbb14f316dd9c1905d117c" args="()" --> |
|
54 <div class="memitem"> |
|
55 <div class="memproto"> |
|
56 <table class="memname"> |
|
57 <tr> |
|
58 <td class="memname"><a class="el" href="class_c_sec_engine.html">CSecEngine</a> * CSecEngine::NewL </td> |
|
59 <td>(</td> |
|
60 <td class="paramname"> </td> |
|
61 <td> ) </td> |
|
62 <td width="100%"><code> [static]</code></td> |
|
63 </tr> |
|
64 </table> |
|
65 </div> |
|
66 <div class="memdoc"> |
|
67 |
|
68 <p> |
|
69 Allocates and constructs a new engine. <dl class="return" compact><dt><b>Returns:</b></dt><dd>New object </dd></dl> |
|
70 |
|
71 <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> |
|
72 |
|
73 </div> |
|
74 </div><p> |
|
75 <a class="anchor" name="b13ef6e8b9c8b4de8c3e6748625c4bd5"></a><!-- doxytag: member="CSecEngine::ConnectL" ref="b13ef6e8b9c8b4de8c3e6748625c4bd5" args="(const TConnectSettings &aConnectSettings)" --> |
|
76 <div class="memitem"> |
|
77 <div class="memproto"> |
|
78 <table class="memname"> |
|
79 <tr> |
|
80 <td class="memname">void CSecEngine::ConnectL </td> |
|
81 <td>(</td> |
|
82 <td class="paramtype">const <a class="el" href="struct_t_connect_settings.html">TConnectSettings</a> & </td> |
|
83 <td class="paramname"> <em>aConnectSettings</em> </td> |
|
84 <td> ) </td> |
|
85 <td width="100%"></td> |
|
86 </tr> |
|
87 </table> |
|
88 </div> |
|
89 <div class="memdoc"> |
|
90 |
|
91 <p> |
|
92 Initiates the connection to a server and the transaction<p> |
|
93 <dl compact><dt><b>Parameters:</b></dt><dd> |
|
94 <table border="0" cellspacing="2" cellpadding="0"> |
|
95 <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> |
|
96 <tr><td valign="top"></td><td valign="top"><em>aPortNum</em> </td><td>Server port for secure web (e.g. 443)</td></tr> |
|
97 <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> |
|
98 <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> |
|
99 <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> |
|
100 </table> |
|
101 </dl> |
|
102 |
|
103 <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> |
|
104 |
|
105 </div> |
|
106 </div><p> |
|
107 <a class="anchor" name="b1a5a2132c12cfc0d9a5fed49cb739c2"></a><!-- doxytag: member="CSecEngine::SetConsole" ref="b1a5a2132c12cfc0d9a5fed49cb739c2" args="(CConsoleBase &aConsole)" --> |
|
108 <div class="memitem"> |
|
109 <div class="memproto"> |
|
110 <table class="memname"> |
|
111 <tr> |
|
112 <td class="memname">void CSecEngine::SetConsole </td> |
|
113 <td>(</td> |
|
114 <td class="paramtype">CConsoleBase & </td> |
|
115 <td class="paramname"> <em>aConsole</em> </td> |
|
116 <td> ) </td> |
|
117 <td width="100%"></td> |
|
118 </tr> |
|
119 </table> |
|
120 </div> |
|
121 <div class="memdoc"> |
|
122 |
|
123 <p> |
|
124 Sets the console to write messages to<p> |
|
125 <dl compact><dt><b>Parameters:</b></dt><dd> |
|
126 <table border="0" cellspacing="2" cellpadding="0"> |
|
127 <tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The console </td></tr> |
|
128 </table> |
|
129 </dl> |
|
130 |
|
131 <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> |
|
132 |
|
133 </div> |
|
134 </div><p> |
|
135 <a class="anchor" name="2d03d9e8d0822c833de323b54eb20c62"></a><!-- doxytag: member="CSecEngine::SetOutputFile" ref="2d03d9e8d0822c833de323b54eb20c62" args="(RFile &aOutputFile)" --> |
|
136 <div class="memitem"> |
|
137 <div class="memproto"> |
|
138 <table class="memname"> |
|
139 <tr> |
|
140 <td class="memname">void CSecEngine::SetOutputFile </td> |
|
141 <td>(</td> |
|
142 <td class="paramtype">RFile & </td> |
|
143 <td class="paramname"> <em>aOutputFile</em> </td> |
|
144 <td> ) </td> |
|
145 <td width="100%"></td> |
|
146 </tr> |
|
147 </table> |
|
148 </div> |
|
149 <div class="memdoc"> |
|
150 |
|
151 <p> |
|
152 Sets the (opened) file to write server response to<p> |
|
153 <dl compact><dt><b>Parameters:</b></dt><dd> |
|
154 <table border="0" cellspacing="2" cellpadding="0"> |
|
155 <tr><td valign="top"></td><td valign="top"><em>aOutputFile</em> </td><td>The file </td></tr> |
|
156 </table> |
|
157 </dl> |
|
158 |
|
159 <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> |
|
160 |
|
161 </div> |
|
162 </div><p> |
|
163 <a class="anchor" name="137260c67a287dd2519efc99df880e5c"></a><!-- doxytag: member="CSecEngine::InUse" ref="137260c67a287dd2519efc99df880e5c" args="()" --> |
|
164 <div class="memitem"> |
|
165 <div class="memproto"> |
|
166 <table class="memname"> |
|
167 <tr> |
|
168 <td class="memname">TBool CSecEngine::InUse </td> |
|
169 <td>(</td> |
|
170 <td class="paramname"> </td> |
|
171 <td> ) </td> |
|
172 <td width="100%"></td> |
|
173 </tr> |
|
174 </table> |
|
175 </div> |
|
176 <div class="memdoc"> |
|
177 |
|
178 <p> |
|
179 Tests if the connection is in progress.<p> |
|
180 <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if in progress else false </dd></dl> |
|
181 |
|
182 <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> |
|
183 |
|
184 </div> |
|
185 </div><p> |
|
186 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by |
|
187 <a href="http://www.doxygen.org/index.html"> |
|
188 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
189 </body> |
|
190 </html> |