← Back to branch summary

~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.protocols.xmlstream.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
Import upstream version 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/twisted.protocols.xmlstream.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>twisted.protocols.xmlstream</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.protocols.html">Package&nbsp;protocols</a> ::
 
34
        Module&nbsp;xmlstream
 
35
      </b></font></br>
 
36
    </td>
 
37
    <td><table cellpadding="0" cellspacing="0">
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.protocols.xmlstream.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF MODULE DESCRIPTION =========== -->
 
43
<h2 class="module">Module twisted.protocols.xmlstream</h2>
 
44
 
 
45
 
 
46
<!-- =========== START OF CLASSES =========== -->
 
47
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
48
<tr bgcolor="#70b0f0" class="summary">
 
49
  <th colspan="2">Classes</th></tr>
 
50
<tr><td width="15%">
 
51
  <b><a href="twisted.protocols.xmlstream.Authenticator.html"><code>Authenticator</code></a></b></td>
 
52
  <td>Base class for business logic of authenticating an XmlStream</td></tr>
 
53
<tr><td width="15%">
 
54
  <b><a href="twisted.protocols.xmlstream.ConnectAuthenticator.html"><code>ConnectAuthenticator</code></a></b></td>
 
55
  <td>&nbsp;</td></tr>
 
56
<tr><td width="15%">
 
57
  <b><a href="twisted.protocols.xmlstream.XmlStream.html"><code>XmlStream</code></a></b></td>
 
58
  <td>&nbsp;</td></tr>
 
59
<tr><td width="15%">
 
60
  <b><a href="twisted.protocols.xmlstream.XmlStreamFactory.html"><code>XmlStreamFactory</code></a></b></td>
 
61
  <td>&nbsp;</td></tr>
 
62
</table><br />
 
63
 
 
64
 
 
65
<!-- =========== START OF FUNCTION SUMMARY =========== -->
 
66
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
67
<tr bgcolor="#70b0f0" class="summary">
 
68
  <th colspan="2">Function Summary</th></tr>
 
69
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
70
  <td><code><span class="summary-sig"><a href="twisted.protocols.xmlstream.html#hashPassword" class="summary-sig-name"><code>hashPassword</code></a>(<span class=summary-sig-arg>sid</span>,
 
71
          <span class=summary-sig-arg>password</span>)</span></code>
 
72
<br />
 
73
Create a SHA1-digest string of a session identifier and password</td></tr>
 
74
</table><br />
 
75
 
 
76
 
 
77
<!-- =========== START OF VARIABLE SUMMARY =========== -->
 
78
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
79
<tr bgcolor="#70b0f0" class="summary">
 
80
  <th colspan="2">Variable Summary</th></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
82
<td><b><a href="twisted.protocols.xmlstream.html#RAWDATA_IN_EVENT"><code>RAWDATA_IN_EVENT</code></a></b> = <span title="'//event/rawdata/in'"><code><span class="variable-quote">'</span>//event/rawdata/in<span class="variable-quote">'</span>                  </code>
 
83
</span></td></tr>
 
84
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
85
<td><b><a href="twisted.protocols.xmlstream.html#RAWDATA_OUT_EVENT"><code>RAWDATA_OUT_EVENT</code></a></b> = <span title="'//event/rawdata/out'"><code><span class="variable-quote">'</span>//event/rawdata/out<span class="variable-quote">'</span>                </code>
 
86
</span></td></tr>
 
87
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
88
<td><b><a href="twisted.protocols.xmlstream.html#STREAM_AUTHD_EVENT"><code>STREAM_AUTHD_EVENT</code></a></b> = <span title="'//event/stream/authd'"><code><span class="variable-quote">'</span>//event/stream/authd<span class="variable-quote">'</span>              </code>
 
89
</span></td></tr>
 
90
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
91
<td><b><a href="twisted.protocols.xmlstream.html#STREAM_CONNECTED_EVENT"><code>STREAM_CONNECTED_EVENT</code></a></b> = <span title="'//event/stream/connected'"><code><span class="variable-quote">'</span>//event/stream/connected<span class="variable-quote">'</span>      </code>
 
92
</span></td></tr>
 
93
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
94
<td><b><a href="twisted.protocols.xmlstream.html#STREAM_END_EVENT"><code>STREAM_END_EVENT</code></a></b> = <span title="'//event/stream/end'"><code><span class="variable-quote">'</span>//event/stream/end<span class="variable-quote">'</span>                  </code>
 
95
</span></td></tr>
 
96
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
97
<td><b><a href="twisted.protocols.xmlstream.html#STREAM_ERROR_EVENT"><code>STREAM_ERROR_EVENT</code></a></b> = <span title="'//event/stream/error'"><code><span class="variable-quote">'</span>//event/stream/error<span class="variable-quote">'</span>              </code>
 
98
</span></td></tr>
 
99
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
 
100
<td><b><a href="twisted.protocols.xmlstream.html#STREAM_START_EVENT"><code>STREAM_START_EVENT</code></a></b> = <span title="'//event/stream/start'"><code><span class="variable-quote">'</span>//event/stream/start<span class="variable-quote">'</span>              </code>
 
101
</span></td></tr>
 
102
</table><br />
 
103
 
 
104
 
 
105
<!-- =========== START OF FUNCTION DETAILS =========== -->
 
106
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
107
<tr bgcolor="#70b0f0" class="details">
 
108
  <th colspan="2">Function Details</th></tr>
 
109
</table>
 
110
 
 
111
<a name="hashPassword"></a>
 
112
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
113
  <h3><span class="sig"><span class="sig-name">hashPassword</span>(<span class=sig-arg>sid</span>,
 
114
          <span class=sig-arg>password</span>)</span>
 
115
  </h3>
 
116
  Create a SHA1-digest string of a session identifier and password
 
117
  <dl><dt></dt><dd>
 
118
  </dd></dl>
 
119
</td></tr></table>
 
120
<br />
 
121
 
 
122
 
 
123
<!-- =========== START OF VARIABLE DETAILS =========== -->
 
124
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
125
<tr bgcolor="#70b0f0" class="details">
 
126
  <th colspan="2">Variable Details</th></tr>
 
127
</table>
 
128
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
129
<a name="RAWDATA_IN_EVENT"></a>
 
130
<h3>RAWDATA_IN_EVENT</h3>
 
131
<dl>
 
132
  <dt></dt>
 
133
  <dd>
 
134
    <dl>
 
135
      <dt><b>Type:</b></dt>
 
136
      <dd>
 
137
          <code>str</code>
 
138
 
 
139
      </dd>
 
140
<span title="'//event/rawdata/in'">      <dt><b>Value:</b></dt>
 
141
      <dd><table><tr><td>
 
142
<pre class="variable">
 
143
<span class="variable-quote">'</span>//event/rawdata/in<span class="variable-quote">'</span>                                                   </pre>
 
144
        </td></tr></table></dd>
 
145
</span>    </dl>
 
146
  </dd>
 
147
</dl></td></tr></table>
 
148
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
149
<a name="RAWDATA_OUT_EVENT"></a>
 
150
<h3>RAWDATA_OUT_EVENT</h3>
 
151
<dl>
 
152
  <dt></dt>
 
153
  <dd>
 
154
    <dl>
 
155
      <dt><b>Type:</b></dt>
 
156
      <dd>
 
157
          <code>str</code>
 
158
 
 
159
      </dd>
 
160
<span title="'//event/rawdata/out'">      <dt><b>Value:</b></dt>
 
161
      <dd><table><tr><td>
 
162
<pre class="variable">
 
163
<span class="variable-quote">'</span>//event/rawdata/out<span class="variable-quote">'</span>                                                  </pre>
 
164
        </td></tr></table></dd>
 
165
</span>    </dl>
 
166
  </dd>
 
167
</dl></td></tr></table>
 
168
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
169
<a name="STREAM_AUTHD_EVENT"></a>
 
170
<h3>STREAM_AUTHD_EVENT</h3>
 
171
<dl>
 
172
  <dt></dt>
 
173
  <dd>
 
174
    <dl>
 
175
      <dt><b>Type:</b></dt>
 
176
      <dd>
 
177
          <code>str</code>
 
178
 
 
179
      </dd>
 
180
<span title="'//event/stream/authd'">      <dt><b>Value:</b></dt>
 
181
      <dd><table><tr><td>
 
182
<pre class="variable">
 
183
<span class="variable-quote">'</span>//event/stream/authd<span class="variable-quote">'</span>                                                 </pre>
 
184
        </td></tr></table></dd>
 
185
</span>    </dl>
 
186
  </dd>
 
187
</dl></td></tr></table>
 
188
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
189
<a name="STREAM_CONNECTED_EVENT"></a>
 
190
<h3>STREAM_CONNECTED_EVENT</h3>
 
191
<dl>
 
192
  <dt></dt>
 
193
  <dd>
 
194
    <dl>
 
195
      <dt><b>Type:</b></dt>
 
196
      <dd>
 
197
          <code>str</code>
 
198
 
 
199
      </dd>
 
200
<span title="'//event/stream/connected'">      <dt><b>Value:</b></dt>
 
201
      <dd><table><tr><td>
 
202
<pre class="variable">
 
203
<span class="variable-quote">'</span>//event/stream/connected<span class="variable-quote">'</span>                                             </pre>
 
204
        </td></tr></table></dd>
 
205
</span>    </dl>
 
206
  </dd>
 
207
</dl></td></tr></table>
 
208
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
209
<a name="STREAM_END_EVENT"></a>
 
210
<h3>STREAM_END_EVENT</h3>
 
211
<dl>
 
212
  <dt></dt>
 
213
  <dd>
 
214
    <dl>
 
215
      <dt><b>Type:</b></dt>
 
216
      <dd>
 
217
          <code>str</code>
 
218
 
 
219
      </dd>
 
220
<span title="'//event/stream/end'">      <dt><b>Value:</b></dt>
 
221
      <dd><table><tr><td>
 
222
<pre class="variable">
 
223
<span class="variable-quote">'</span>//event/stream/end<span class="variable-quote">'</span>                                                   </pre>
 
224
        </td></tr></table></dd>
 
225
</span>    </dl>
 
226
  </dd>
 
227
</dl></td></tr></table>
 
228
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
229
<a name="STREAM_ERROR_EVENT"></a>
 
230
<h3>STREAM_ERROR_EVENT</h3>
 
231
<dl>
 
232
  <dt></dt>
 
233
  <dd>
 
234
    <dl>
 
235
      <dt><b>Type:</b></dt>
 
236
      <dd>
 
237
          <code>str</code>
 
238
 
 
239
      </dd>
 
240
<span title="'//event/stream/error'">      <dt><b>Value:</b></dt>
 
241
      <dd><table><tr><td>
 
242
<pre class="variable">
 
243
<span class="variable-quote">'</span>//event/stream/error<span class="variable-quote">'</span>                                                 </pre>
 
244
        </td></tr></table></dd>
 
245
</span>    </dl>
 
246
  </dd>
 
247
</dl></td></tr></table>
 
248
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
249
<a name="STREAM_START_EVENT"></a>
 
250
<h3>STREAM_START_EVENT</h3>
 
251
<dl>
 
252
  <dt></dt>
 
253
  <dd>
 
254
    <dl>
 
255
      <dt><b>Type:</b></dt>
 
256
      <dd>
 
257
          <code>str</code>
 
258
 
 
259
      </dd>
 
260
<span title="'//event/stream/start'">      <dt><b>Value:</b></dt>
 
261
      <dd><table><tr><td>
 
262
<pre class="variable">
 
263
<span class="variable-quote">'</span>//event/stream/start<span class="variable-quote">'</span>                                                 </pre>
 
264
        </td></tr></table></dd>
 
265
</span>    </dl>
 
266
  </dd>
 
267
</dl></td></tr></table>
 
268
<br />
 
269
 
 
270
 
 
271
<!-- =========== START OF NAVBAR =========== -->
 
272
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
273
  <tr valign="center">
 
274
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
275
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
276
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
277
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
278
    <th class="navbar" align="right" width="100%">
 
279
      <table border="0" cellpadding="0" cellspacing="0">
 
280
      <tr><th class="navbar" align="center">
 
281
        <p class="nomargin">
 
282
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
283
      </p></th></tr></table>
 
284
    </th>
 
285
  </tr>
 
286
</table>
 
287
 
 
288
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
289
  <tr>
 
290
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:37 2004</font></td>
 
291
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
292
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
293
  </tr>
 
294
</table>
 
295
</body>
 
296
</html>