← Back to branch summary

~ubuntu-branches/ubuntu/wily/qca2/wily-proposed

« back to all changes in this revision

Viewing changes to qca/apidocs/html/classQCA_1_1SASL_1_1Params.html

  • Committer: Bazaar Package Importer
  • Author(s): Jan Niehusmann
  • Date: 2007-10-27 18:51:54 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20071027185154-4ir9ys3h2q9fofrw
Tags: 2.0.0-2
Upload to unstable

Show diffs side-by-side

added added

removed removed

Lines of Context:
qca/apidocs/html/classQCA_1_1SASL_1_1Params.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>Qt Cryptographic Architecture: QCA::SASL::Params 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.4.6 -->
8
 
<div class="tabs">
9
 
  <ul>
10
 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
 
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12
 
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
13
 
    <li><a href="files.html"><span>Files</span></a></li>
14
 
    <li><a href="dirs.html"><span>Directories</span></a></li>
15
 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16
 
    <li><a href="examples.html"><span>Examples</span></a></li>
17
 
  </ul></div>
18
 
<div class="tabs">
19
 
  <ul>
20
 
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21
 
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22
 
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23
 
  </ul></div>
24
 
<div class="nav">
25
 
<a class="el" href="namespaceQCA.html">QCA</a>::<a class="el" href="classQCA_1_1SASL.html">SASL</a>::<a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a></div>
26
 
<h1>QCA::SASL::Params Class Reference</h1><!-- doxytag: class="QCA::SASL::Params" -->Parameter flags for the <a class="el" href="classQCA_1_1SASL.html">SASL</a> authentication.  
27
 
<a href="#_details">More...</a>
28
 
<p>
29
 
<code>#include &lt;<a class="el" href="qca__securelayer_8h-source.html">QtCrypto</a>&gt;</code>
30
 
<p>
31
 
Collaboration diagram for QCA::SASL::Params:<p><center><img src="classQCA_1_1SASL_1_1Params__coll__graph.png" border="0" usemap="#QCA_1_1SASL_1_1Params__coll__map" alt="Collaboration graph"></center>
32
 
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classQCA_1_1SASL_1_1Params-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
33
 
<tr><td></td></tr>
34
 
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
35
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#8e8d10793e39f3b7421171d53d8e93f0">Params</a> (bool user, bool authzid, bool pass, bool realm)</td></tr>
36
 
 
37
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#9f1e4deb4000db19d9f30947ec538401">Params</a> (const <a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> &amp;from)</td></tr>
38
 
 
39
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#5dc0cfc0178b3973a962f5bb7e71ec8c">operator=</a> (const <a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> &amp;from)</td></tr>
40
 
 
41
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#7227c4b0ae319a8ab31524fdbd41c95a">needUsername</a> () const </td></tr>
42
 
 
43
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#0d894a3c841292cbe512a472694f3d06">canSendAuthzid</a> () const </td></tr>
44
 
 
45
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#71793cf357972d30d058685d6f802794">needPassword</a> () const </td></tr>
46
 
 
47
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classQCA_1_1SASL_1_1Params.html#860baabfb6c3552518d04e450db97d3c">canSendRealm</a> () const </td></tr>
48
 
 
49
 
</table>
50
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
51
 
Parameter flags for the <a class="el" href="classQCA_1_1SASL.html">SASL</a> authentication. 
52
 
<p>
53
 
This is used to indicate which parameters are needed by <a class="el" href="classQCA_1_1SASL.html">SASL</a> in order to complete the authentication process. <dl compact><dt><b>Examples: </b></dt><dd>
54
 
 
55
 
<p>
56
 
<a class="el" href="sasltest_8cpp-example.html#_a283">sasltest.cpp</a>.</dl>
57
 
<p>
58
 
<hr><h2>Constructor &amp; Destructor Documentation</h2>
59
 
<a class="anchor" name="8e8d10793e39f3b7421171d53d8e93f0"></a><!-- doxytag: member="QCA::SASL::Params::Params" ref="8e8d10793e39f3b7421171d53d8e93f0" args="(bool user, bool authzid, bool pass, bool realm)" --><p>
60
 
<table class="mdTable" cellpadding="2" cellspacing="0">
61
 
  <tr>
62
 
    <td class="mdRow">
63
 
      <table cellpadding="0" cellspacing="0" border="0">
64
 
        <tr>
65
 
          <td class="md" nowrap valign="top">QCA::SASL::Params::Params           </td>
66
 
          <td class="md" valign="top">(&nbsp;</td>
67
 
          <td class="md" nowrap valign="top">bool&nbsp;</td>
68
 
          <td class="mdname" nowrap> <em>user</em>, </td>
69
 
        </tr>
70
 
        <tr>
71
 
          <td class="md" nowrap align="right"></td>
72
 
          <td class="md"></td>
73
 
          <td class="md" nowrap>bool&nbsp;</td>
74
 
          <td class="mdname" nowrap> <em>authzid</em>, </td>
75
 
        </tr>
76
 
        <tr>
77
 
          <td class="md" nowrap align="right"></td>
78
 
          <td class="md"></td>
79
 
          <td class="md" nowrap>bool&nbsp;</td>
80
 
          <td class="mdname" nowrap> <em>pass</em>, </td>
81
 
        </tr>
82
 
        <tr>
83
 
          <td class="md" nowrap align="right"></td>
84
 
          <td class="md"></td>
85
 
          <td class="md" nowrap>bool&nbsp;</td>
86
 
          <td class="mdname" nowrap> <em>realm</em></td>
87
 
        </tr>
88
 
        <tr>
89
 
          <td class="md"></td>
90
 
          <td class="md">)&nbsp;</td>
91
 
          <td class="md" colspan="2"></td>
92
 
        </tr>
93
 
      </table>
94
 
    </td>
95
 
  </tr>
96
 
</table>
97
 
<table cellspacing="5" cellpadding="0" border="0">
98
 
  <tr>
99
 
    <td>
100
 
      &nbsp;
101
 
    </td>
102
 
    <td>
103
 
 
104
 
<p>
105
 
Standard constructor. 
106
 
<p>
107
 
The concept behind this is that you set each of the flags depending on which parameters are needed.<p>
108
 
<dl compact><dt><b>Parameters:</b></dt><dd>
109
 
  <table border="0" cellspacing="2" cellpadding="0">
110
 
    <tr><td valign="top"></td><td valign="top"><em>user</em>&nbsp;</td><td>the username is required </td></tr>
111
 
    <tr><td valign="top"></td><td valign="top"><em>authzid</em>&nbsp;</td><td>the authorization identity is required </td></tr>
112
 
    <tr><td valign="top"></td><td valign="top"><em>pass</em>&nbsp;</td><td>the password is required </td></tr>
113
 
    <tr><td valign="top"></td><td valign="top"><em>realm</em>&nbsp;</td><td>the realm is required </td></tr>
114
 
  </table>
115
 
</dl>
116
 
    </td>
117
 
  </tr>
118
 
</table>
119
 
<a class="anchor" name="9f1e4deb4000db19d9f30947ec538401"></a><!-- doxytag: member="QCA::SASL::Params::Params" ref="9f1e4deb4000db19d9f30947ec538401" args="(const Params &amp;from)" --><p>
120
 
<table class="mdTable" cellpadding="2" cellspacing="0">
121
 
  <tr>
122
 
    <td class="mdRow">
123
 
      <table cellpadding="0" cellspacing="0" border="0">
124
 
        <tr>
125
 
          <td class="md" nowrap valign="top">QCA::SASL::Params::Params           </td>
126
 
          <td class="md" valign="top">(&nbsp;</td>
127
 
          <td class="md" nowrap valign="top">const <a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> &amp;&nbsp;</td>
128
 
          <td class="mdname1" valign="top" nowrap> <em>from</em>          </td>
129
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
130
 
          <td class="md" nowrap></td>
131
 
        </tr>
132
 
      </table>
133
 
    </td>
134
 
  </tr>
135
 
</table>
136
 
<table cellspacing="5" cellpadding="0" border="0">
137
 
  <tr>
138
 
    <td>
139
 
      &nbsp;
140
 
    </td>
141
 
    <td>
142
 
 
143
 
<p>
144
 
Standard copy constructor. 
145
 
<p>
146
 
<dl compact><dt><b>Parameters:</b></dt><dd>
147
 
  <table border="0" cellspacing="2" cellpadding="0">
148
 
    <tr><td valign="top"></td><td valign="top"><em>from</em>&nbsp;</td><td>the <a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> object to copy </td></tr>
149
 
  </table>
150
 
</dl>
151
 
    </td>
152
 
  </tr>
153
 
</table>
154
 
<hr><h2>Member Function Documentation</h2>
155
 
<a class="anchor" name="5dc0cfc0178b3973a962f5bb7e71ec8c"></a><!-- doxytag: member="QCA::SASL::Params::operator=" ref="5dc0cfc0178b3973a962f5bb7e71ec8c" args="(const Params &amp;from)" --><p>
156
 
<table class="mdTable" cellpadding="2" cellspacing="0">
157
 
  <tr>
158
 
    <td class="mdRow">
159
 
      <table cellpadding="0" cellspacing="0" border="0">
160
 
        <tr>
161
 
          <td class="md" nowrap valign="top"><a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a>&amp; QCA::SASL::Params::operator=           </td>
162
 
          <td class="md" valign="top">(&nbsp;</td>
163
 
          <td class="md" nowrap valign="top">const <a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> &amp;&nbsp;</td>
164
 
          <td class="mdname1" valign="top" nowrap> <em>from</em>          </td>
165
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
166
 
          <td class="md" nowrap></td>
167
 
        </tr>
168
 
      </table>
169
 
    </td>
170
 
  </tr>
171
 
</table>
172
 
<table cellspacing="5" cellpadding="0" border="0">
173
 
  <tr>
174
 
    <td>
175
 
      &nbsp;
176
 
    </td>
177
 
    <td>
178
 
 
179
 
<p>
180
 
Standard assignment operator. 
181
 
<p>
182
 
<dl compact><dt><b>Parameters:</b></dt><dd>
183
 
  <table border="0" cellspacing="2" cellpadding="0">
184
 
    <tr><td valign="top"></td><td valign="top"><em>from</em>&nbsp;</td><td>the <a class="el" href="classQCA_1_1SASL_1_1Params.html">Params</a> object to assign from </td></tr>
185
 
  </table>
186
 
</dl>
187
 
    </td>
188
 
  </tr>
189
 
</table>
190
 
<a class="anchor" name="7227c4b0ae319a8ab31524fdbd41c95a"></a><!-- doxytag: member="QCA::SASL::Params::needUsername" ref="7227c4b0ae319a8ab31524fdbd41c95a" args="() const " --><p>
191
 
<table class="mdTable" cellpadding="2" cellspacing="0">
192
 
  <tr>
193
 
    <td class="mdRow">
194
 
      <table cellpadding="0" cellspacing="0" border="0">
195
 
        <tr>
196
 
          <td class="md" nowrap valign="top">bool QCA::SASL::Params::needUsername           </td>
197
 
          <td class="md" valign="top">(&nbsp;</td>
198
 
          <td class="mdname1" valign="top" nowrap>          </td>
199
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
200
 
          <td class="md" nowrap> const</td>
201
 
        </tr>
202
 
      </table>
203
 
    </td>
204
 
  </tr>
205
 
</table>
206
 
<table cellspacing="5" cellpadding="0" border="0">
207
 
  <tr>
208
 
    <td>
209
 
      &nbsp;
210
 
    </td>
211
 
    <td>
212
 
 
213
 
<p>
214
 
User is needed. 
215
 
<p>
216
 
<dl compact><dt><b>Examples: </b></dt><dd>
217
 
<a class="el" href="sasltest_8cpp-example.html#a296">sasltest.cpp</a>.</dl>    </td>
218
 
  </tr>
219
 
</table>
220
 
<a class="anchor" name="0d894a3c841292cbe512a472694f3d06"></a><!-- doxytag: member="QCA::SASL::Params::canSendAuthzid" ref="0d894a3c841292cbe512a472694f3d06" args="() const " --><p>
221
 
<table class="mdTable" cellpadding="2" cellspacing="0">
222
 
  <tr>
223
 
    <td class="mdRow">
224
 
      <table cellpadding="0" cellspacing="0" border="0">
225
 
        <tr>
226
 
          <td class="md" nowrap valign="top">bool QCA::SASL::Params::canSendAuthzid           </td>
227
 
          <td class="md" valign="top">(&nbsp;</td>
228
 
          <td class="mdname1" valign="top" nowrap>          </td>
229
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
230
 
          <td class="md" nowrap> const</td>
231
 
        </tr>
232
 
      </table>
233
 
    </td>
234
 
  </tr>
235
 
</table>
236
 
<table cellspacing="5" cellpadding="0" border="0">
237
 
  <tr>
238
 
    <td>
239
 
      &nbsp;
240
 
    </td>
241
 
    <td>
242
 
 
243
 
<p>
244
 
An Authorization ID can be sent if desired. 
245
 
<p>
246
 
<dl compact><dt><b>Examples: </b></dt><dd>
247
 
<a class="el" href="sasltest_8cpp-example.html#a297">sasltest.cpp</a>.</dl>    </td>
248
 
  </tr>
249
 
</table>
250
 
<a class="anchor" name="71793cf357972d30d058685d6f802794"></a><!-- doxytag: member="QCA::SASL::Params::needPassword" ref="71793cf357972d30d058685d6f802794" args="() const " --><p>
251
 
<table class="mdTable" cellpadding="2" cellspacing="0">
252
 
  <tr>
253
 
    <td class="mdRow">
254
 
      <table cellpadding="0" cellspacing="0" border="0">
255
 
        <tr>
256
 
          <td class="md" nowrap valign="top">bool QCA::SASL::Params::needPassword           </td>
257
 
          <td class="md" valign="top">(&nbsp;</td>
258
 
          <td class="mdname1" valign="top" nowrap>          </td>
259
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
260
 
          <td class="md" nowrap> const</td>
261
 
        </tr>
262
 
      </table>
263
 
    </td>
264
 
  </tr>
265
 
</table>
266
 
<table cellspacing="5" cellpadding="0" border="0">
267
 
  <tr>
268
 
    <td>
269
 
      &nbsp;
270
 
    </td>
271
 
    <td>
272
 
 
273
 
<p>
274
 
Password is needed. 
275
 
<p>
276
 
<dl compact><dt><b>Examples: </b></dt><dd>
277
 
<a class="el" href="sasltest_8cpp-example.html#a298">sasltest.cpp</a>.</dl>    </td>
278
 
  </tr>
279
 
</table>
280
 
<a class="anchor" name="860baabfb6c3552518d04e450db97d3c"></a><!-- doxytag: member="QCA::SASL::Params::canSendRealm" ref="860baabfb6c3552518d04e450db97d3c" args="() const " --><p>
281
 
<table class="mdTable" cellpadding="2" cellspacing="0">
282
 
  <tr>
283
 
    <td class="mdRow">
284
 
      <table cellpadding="0" cellspacing="0" border="0">
285
 
        <tr>
286
 
          <td class="md" nowrap valign="top">bool QCA::SASL::Params::canSendRealm           </td>
287
 
          <td class="md" valign="top">(&nbsp;</td>
288
 
          <td class="mdname1" valign="top" nowrap>          </td>
289
 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
290
 
          <td class="md" nowrap> const</td>
291
 
        </tr>
292
 
      </table>
293
 
    </td>
294
 
  </tr>
295
 
</table>
296
 
<table cellspacing="5" cellpadding="0" border="0">
297
 
  <tr>
298
 
    <td>
299
 
      &nbsp;
300
 
    </td>
301
 
    <td>
302
 
 
303
 
<p>
304
 
A Realm can be sent if desired. 
305
 
<p>
306
 
<dl compact><dt><b>Examples: </b></dt><dd>
307
 
<a class="el" href="sasltest_8cpp-example.html#a299">sasltest.cpp</a>.</dl>    </td>
308
 
  </tr>
309
 
</table>
310
 
<hr>The documentation for this class was generated from the following file:<ul>
311
 
<li><a class="el" href="qca__securelayer_8h-source.html">qca_securelayer.h</a></ul>
312
 
<hr size="1"><address style="align: right;"><small>Generated on Fri Jul 6 13:24:17 2007 for Qt Cryptographic Architecture by&nbsp;
313
 
<a href="http://www.doxygen.org/index.html">
314
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
315
 
</body>
316
 
</html>