|
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: examples/Base/IPC/secureserver/secureserver.h File 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>examples/Base/IPC/secureserver/secureserver.h File Reference</h1> |
|
9 <p> |
|
10 <a href="secureserver_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
|
11 <tr><td></td></tr> |
|
12 <tr><td colspan="2"><br><h2>Classes</h2></td></tr> |
|
13 <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server.html">CSecureServer</a></td></tr> |
|
14 |
|
15 <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_session.html">CSecureServerSession</a></td></tr> |
|
16 |
|
17 <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_secure_server_sub_session.html">CSecureServerSubSession</a></td></tr> |
|
18 |
|
19 <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> |
|
20 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef">TSecureServerPanic</a> { <br> |
|
21 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4efeef6b7f2a8413e6863e2136b93228c3a">EBadRequest</a> = 1, |
|
22 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef59f7e1b1a0e300077050b023b97ebcfb">EDescriptorNonNumeric</a>, |
|
23 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef4dc32eda4a06b69469187275e825d99f">EMainSchedulerError</a>, |
|
24 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef9b127171258d0cdb2748e608aaa757cb">EServerCreateServer</a>, |
|
25 <br> |
|
26 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4efd2d8074b4ac1ba9f45dbb70e6aec4144">EServerStartServer</a>, |
|
27 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef36f3ebda4e94aedb5817599162216e69">ECreateTrapCleanup</a>, |
|
28 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4efeebad163989c978b8edd91b6893411c0">EBadSubsessionHandle</a>, |
|
29 <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef58c52029fd13028de726c112eedc638a">ESecureServerSecurityPolicy</a> |
|
30 <br> |
|
31 }</td></tr> |
|
32 |
|
33 <tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
|
34 <tr><td class="memItemLeft" nowrap align="right" valign="top">const TUint </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#bccd7aceb4760cddd96866248e305f29">KDefaultHeapSize</a> = 0x10000</td></tr> |
|
35 |
|
36 <tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a> = 5</td></tr> |
|
37 |
|
38 <tr><td class="memItemLeft" nowrap align="right" valign="top">const TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#374f11258957fe4902b11706c8d378bf">KSecureServerRanges</a> [<a class="el" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a>]</td></tr> |
|
39 |
|
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <br> |
|
41 CPolicyServer::TPolicyElement </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#96a8dd34c3e8faf09bc5ef7050b5d0ce">KSecureServerElements</a> []</td></tr> |
|
42 |
|
43 <tr><td class="memItemLeft" nowrap align="right" valign="top">const TUint8 </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#1c5ad63aafc1be2736f3a8177f4d7fd9">KSecureServerElementsIndex</a> [<a class="el" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a>]</td></tr> |
|
44 |
|
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <br> |
|
46 CPolicyServer::TPolicy </td><td class="memItemRight" valign="bottom"><a class="el" href="secureserver_8h.html#35e41e8fbb27c5be7ed4ce6c6cd28d2a">KSecureServerPolicy</a></td></tr> |
|
47 |
|
48 </table> |
|
49 <hr><a name="_details"></a><h2>Detailed Description</h2> |
|
50 |
|
51 <p>Definition in file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
52 <hr><h2>Enumeration Type Documentation</h2> |
|
53 <a class="anchor" name="091a5ad2956fb84c4470a59010a0d4ef"></a><!-- doxytag: member="secureserver.h::TSecureServerPanic" ref="091a5ad2956fb84c4470a59010a0d4ef" args="" --> |
|
54 <div class="memitem"> |
|
55 <div class="memproto"> |
|
56 <table class="memname"> |
|
57 <tr> |
|
58 <td class="memname">enum <a class="el" href="secureserver_8h.html#091a5ad2956fb84c4470a59010a0d4ef">TSecureServerPanic</a> </td> |
|
59 </tr> |
|
60 </table> |
|
61 </div> |
|
62 <div class="memdoc"> |
|
63 |
|
64 <p> |
|
65 A set of panic numbers used when the example raises panics in response to programming errors. All panics raised by the example have the category SecureServer. <dl class="see" compact><dt><b>See also:</b></dt><dd>KTxtServer </dd></dl> |
|
66 <dl compact><dt><b>Enumerator: </b></dt><dd> |
|
67 <table border="0" cellspacing="2" cellpadding="0"> |
|
68 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4efeef6b7f2a8413e6863e2136b93228c3a"></a><!-- doxytag: member="EBadRequest" ref="091a5ad2956fb84c4470a59010a0d4efeef6b7f2a8413e6863e2136b93228c3a" args="" -->EBadRequest</em> </td><td> |
|
69 An undefined op code. </td></tr> |
|
70 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4ef59f7e1b1a0e300077050b023b97ebcfb"></a><!-- doxytag: member="EDescriptorNonNumeric" ref="091a5ad2956fb84c4470a59010a0d4ef59f7e1b1a0e300077050b023b97ebcfb" args="" -->EDescriptorNonNumeric</em> </td><td> |
|
71 A descriptor containing non-numeric characters. </td></tr> |
|
72 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4ef4dc32eda4a06b69469187275e825d99f"></a><!-- doxytag: member="EMainSchedulerError" ref="091a5ad2956fb84c4470a59010a0d4ef4dc32eda4a06b69469187275e825d99f" args="" -->EMainSchedulerError</em> </td><td> |
|
73 The Active Scheduler can not be instantiated. </td></tr> |
|
74 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4ef9b127171258d0cdb2748e608aaa757cb"></a><!-- doxytag: member="EServerCreateServer" ref="091a5ad2956fb84c4470a59010a0d4ef9b127171258d0cdb2748e608aaa757cb" args="" -->EServerCreateServer</em> </td><td> |
|
75 The server can not be created. </td></tr> |
|
76 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4efd2d8074b4ac1ba9f45dbb70e6aec4144"></a><!-- doxytag: member="EServerStartServer" ref="091a5ad2956fb84c4470a59010a0d4efd2d8074b4ac1ba9f45dbb70e6aec4144" args="" -->EServerStartServer</em> </td><td> |
|
77 The server can not be added to the active scheduler to receive requests. </td></tr> |
|
78 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4ef36f3ebda4e94aedb5817599162216e69"></a><!-- doxytag: member="ECreateTrapCleanup" ref="091a5ad2956fb84c4470a59010a0d4ef36f3ebda4e94aedb5817599162216e69" args="" -->ECreateTrapCleanup</em> </td><td> |
|
79 The cleanup stack can not be created. </td></tr> |
|
80 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4efeebad163989c978b8edd91b6893411c0"></a><!-- doxytag: member="EBadSubsessionHandle" ref="091a5ad2956fb84c4470a59010a0d4efeebad163989c978b8edd91b6893411c0" args="" -->EBadSubsessionHandle</em> </td><td> |
|
81 The object index of the sub session returns an error. </td></tr> |
|
82 <tr><td valign="top"><em><a class="anchor" name="091a5ad2956fb84c4470a59010a0d4ef58c52029fd13028de726c112eedc638a"></a><!-- doxytag: member="ESecureServerSecurityPolicy" ref="091a5ad2956fb84c4470a59010a0d4ef58c52029fd13028de726c112eedc638a" args="" -->ESecureServerSecurityPolicy</em> </td><td> |
|
83 A custom security policy violation. </td></tr> |
|
84 </table> |
|
85 </dl> |
|
86 |
|
87 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00043">43</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
88 |
|
89 </div> |
|
90 </div><p> |
|
91 <hr><h2>Variable Documentation</h2> |
|
92 <a class="anchor" name="bccd7aceb4760cddd96866248e305f29"></a><!-- doxytag: member="secureserver.h::KDefaultHeapSize" ref="bccd7aceb4760cddd96866248e305f29" args="" --> |
|
93 <div class="memitem"> |
|
94 <div class="memproto"> |
|
95 <table class="memname"> |
|
96 <tr> |
|
97 <td class="memname">const TUint <a class="el" href="secureserver_8h.html#bccd7aceb4760cddd96866248e305f29">KDefaultHeapSize</a> = 0x10000 </td> |
|
98 </tr> |
|
99 </table> |
|
100 </div> |
|
101 <div class="memdoc"> |
|
102 |
|
103 <p> |
|
104 The size of the heap to be allocated for the thread that runs the server. The constant is passed to the <a class="el" href="secureclientandserver_8h.html#f110d475e98114c0f2a42b7313af8e67">StartThread()</a> function defined in <a class="el" href="secureclientandserver_8h.html">secureclientandserver.h</a> and implemented in <a class="el" href="secureserver_8cpp.html">secureserver.cpp</a>. <dl class="see" compact><dt><b>See also:</b></dt><dd>RThread::Create() </dd></dl> |
|
105 |
|
106 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00036">36</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
107 |
|
108 </div> |
|
109 </div><p> |
|
110 <a class="anchor" name="58c74f3d388b4e34764cddd3d0d24c92"></a><!-- doxytag: member="secureserver.h::KSecureServerRangeCount" ref="58c74f3d388b4e34764cddd3d0d24c92" args="" --> |
|
111 <div class="memitem"> |
|
112 <div class="memproto"> |
|
113 <table class="memname"> |
|
114 <tr> |
|
115 <td class="memname">const TInt <a class="el" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a> = 5 </td> |
|
116 </tr> |
|
117 </table> |
|
118 </div> |
|
119 <div class="memdoc"> |
|
120 |
|
121 <p> |
|
122 The server specifies 5 ranges of security policy. Each range undergoes a different security check. <dl class="see" compact><dt><b>See also:</b></dt><dd>CpolicyServer::TPolicy::iRangeCount </dd></dl> |
|
123 |
|
124 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00083">83</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
125 |
|
126 </div> |
|
127 </div><p> |
|
128 <a class="anchor" name="374f11258957fe4902b11706c8d378bf"></a><!-- doxytag: member="secureserver.h::KSecureServerRanges" ref="374f11258957fe4902b11706c8d378bf" args="[KSecureServerRangeCount]" --> |
|
129 <div class="memitem"> |
|
130 <div class="memproto"> |
|
131 <table class="memname"> |
|
132 <tr> |
|
133 <td class="memname">const TInt <a class="el" href="secureserver_8h.html#374f11258957fe4902b11706c8d378bf">KSecureServerRanges</a>[<a class="el" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a>] </td> |
|
134 </tr> |
|
135 </table> |
|
136 </div> |
|
137 <div class="memdoc"> |
|
138 |
|
139 <p> |
|
140 <b>Initial value:</b><div class="fragment"><pre class="fragment"> |
|
141 { |
|
142 |
|
143 0, |
|
144 |
|
145 5, |
|
146 |
|
147 6, |
|
148 |
|
149 11, |
|
150 |
|
151 13 |
|
152 } |
|
153 </pre></div>Ordered ranges of request numbers. <dl class="see" compact><dt><b>See also:</b></dt><dd>CpolicyServer::TPolicy::iRanges </dd></dl> |
|
154 |
|
155 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00089">89</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
156 |
|
157 </div> |
|
158 </div><p> |
|
159 <a class="anchor" name="96a8dd34c3e8faf09bc5ef7050b5d0ce"></a><!-- doxytag: member="secureserver.h::KSecureServerElements" ref="96a8dd34c3e8faf09bc5ef7050b5d0ce" args="[]" --> |
|
160 <div class="memitem"> |
|
161 <div class="memproto"> |
|
162 <table class="memname"> |
|
163 <tr> |
|
164 <td class="memname">const CPolicyServer::TPolicyElement <a class="el" href="secureserver_8h.html#96a8dd34c3e8faf09bc5ef7050b5d0ce">KSecureServerElements</a>[] </td> |
|
165 </tr> |
|
166 </table> |
|
167 </div> |
|
168 <div class="memdoc"> |
|
169 |
|
170 <p> |
|
171 <b>Initial value:</b><div class="fragment"><pre class="fragment"> |
|
172 { |
|
173 |
|
174 _INIT_SECURITY_POLICY_S0(0x70fffff0), |
|
175 |
|
176 {_INIT_SECURITY_POLICY_C1(ECapabilityReadDeviceData | ECapabilityWriteDeviceData), CPolicyServer::EFailClient} |
|
177 } |
|
178 </pre></div>An array containing the unique set of policies used in this example. <dl class="see" compact><dt><b>See also:</b></dt><dd>CpolicyServer::TPolicy::iElements </dd></dl> |
|
179 |
|
180 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00117">117</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
181 |
|
182 </div> |
|
183 </div><p> |
|
184 <a class="anchor" name="1c5ad63aafc1be2736f3a8177f4d7fd9"></a><!-- doxytag: member="secureserver.h::KSecureServerElementsIndex" ref="1c5ad63aafc1be2736f3a8177f4d7fd9" args="[KSecureServerRangeCount]" --> |
|
185 <div class="memitem"> |
|
186 <div class="memproto"> |
|
187 <table class="memname"> |
|
188 <tr> |
|
189 <td class="memname">const TUint8 <a class="el" href="secureserver_8h.html#1c5ad63aafc1be2736f3a8177f4d7fd9">KSecureServerElementsIndex</a>[<a class="el" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a>] </td> |
|
190 </tr> |
|
191 </table> |
|
192 </div> |
|
193 <div class="memdoc"> |
|
194 |
|
195 <p> |
|
196 <b>Initial value:</b><div class="fragment"><pre class="fragment"> |
|
197 { |
|
198 |
|
199 CPolicyServer::EAlwaysPass, |
|
200 |
|
201 0, |
|
202 |
|
203 CPolicyServer::ECustomCheck, |
|
204 |
|
205 1, |
|
206 |
|
207 CPolicyServer::ENotSupported |
|
208 } |
|
209 </pre></div>An array of TUint8 values that specify the action to take for each range in KSecureServerRanges array. <dl class="see" compact><dt><b>See also:</b></dt><dd>CpolicyServer::TPolicy::iElementsIndex </dd></dl> |
|
210 |
|
211 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00133">133</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
212 |
|
213 </div> |
|
214 </div><p> |
|
215 <a class="anchor" name="35e41e8fbb27c5be7ed4ce6c6cd28d2a"></a><!-- doxytag: member="secureserver.h::KSecureServerPolicy" ref="35e41e8fbb27c5be7ed4ce6c6cd28d2a" args="" --> |
|
216 <div class="memitem"> |
|
217 <div class="memproto"> |
|
218 <table class="memname"> |
|
219 <tr> |
|
220 <td class="memname">const CPolicyServer::TPolicy <a class="el" href="secureserver_8h.html#35e41e8fbb27c5be7ed4ce6c6cd28d2a">KSecureServerPolicy</a> </td> |
|
221 </tr> |
|
222 </table> |
|
223 </div> |
|
224 <div class="memdoc"> |
|
225 |
|
226 <p> |
|
227 <b>Initial value:</b><div class="fragment"><pre class="fragment"> |
|
228 { |
|
229 |
|
230 CPolicyServer::EAlwaysPass, |
|
231 <a class="code" href="secureserver_8h.html#58c74f3d388b4e34764cddd3d0d24c92">KSecureServerRangeCount</a>, |
|
232 <a class="code" href="secureserver_8h.html#374f11258957fe4902b11706c8d378bf">KSecureServerRanges</a>, |
|
233 <a class="code" href="secureserver_8h.html#1c5ad63aafc1be2736f3a8177f4d7fd9">KSecureServerElementsIndex</a>, |
|
234 <a class="code" href="secureserver_8h.html#96a8dd34c3e8faf09bc5ef7050b5d0ce">KSecureServerElements</a> |
|
235 } |
|
236 </pre></div>The security policy of the server. This is passed to the constructor of the policy server. In this example, this is the constructor of the <a class="el" href="class_c_secure_server.html">CSecureServer</a> class. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="class_c_secure_server.html">CSecureServer</a> </dd></dl> |
|
237 |
|
238 <p>Definition at line <a class="el" href="secureserver_8h-source.html#l00167">167</a> of file <a class="el" href="secureserver_8h-source.html">secureserver.h</a>.</p> |
|
239 |
|
240 </div> |
|
241 </div><p> |
|
242 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:02 2010 for TB10.1 Example Applications by |
|
243 <a href="http://www.doxygen.org/index.html"> |
|
244 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
245 </body> |
|
246 </html> |