1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>nbxmpp.protocol.BOSHBody</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="nbxmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="nbxmpp-module.html">Package nbxmpp</a> ::
<a href="nbxmpp.protocol-module.html">Module protocol</a> ::
Class BOSHBody
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="nbxmpp.protocol.BOSHBody-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class BOSHBody</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.protocol-pysrc.html#BOSHBody">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_nbxmpp_p_3" name="uml_class_diagram_for_nbxmpp_p_3">
<area shape="rect" id="node44" href="nbxmpp.protocol.BOSHBody-class.html#__init__" title="Takes "tag" argument as the name of node (prepended by namespace, if needed and separated from it by a space), attrs dictionary as the set of arguments, payload list as the set of textual strings and child nodes that this node carries within itself and "parent" argument that is another node that this one will be the child of. Also the __init__ can be provided with "node" argument that is either a text string containing exactly one node or another Node instance to begin with. If both "node" and other arguments is provided then the node initially created as replica of "node" provided and then modified to be compliant with other arguments." alt="" coords="129,391,445,409"/>
<area shape="rect" id="node1" href="nbxmpp.protocol.BOSHBody-class.html" title="<body> tag that wraps usual XMPP stanzas in XMPP over BOSH" alt="" coords="117,358,456,415"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#FORCE_NODE_RECREATION" title="nbxmpp.simplexml.Node.FORCE_NODE_RECREATION" alt="" coords="17,31,559,49"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#lookup_nsp" title="nbxmpp.simplexml.Node.lookup_nsp" alt="" coords="17,52,559,71"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#__str__" title="Method used to dump node into textual representation. If "fancy" argument is set to True produces indented output for readability" alt="" coords="17,71,559,89"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#addChild" title="If "node" argument is provided, adds it as child node. Else creates new node from the other arguments' values and adds it as well" alt="" coords="17,89,559,108"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#addData" title="Add some CDATA to node" alt="" coords="17,108,559,127"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#clearData" title="Remove all CDATA from the node" alt="" coords="17,127,559,145"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#delAttr" title="Delete an attribute "key"" alt="" coords="17,145,559,164"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#delChild" title="Delete the "node" from the node's childs list, if "node" is an instance. Else delete the first node that have specified name and (optionally) attributes" alt="" coords="17,164,559,183"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#getAttrs" title="Return all node's attributes as dictionary" alt="" coords="17,183,559,201"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#getAttr" title="Return value of specified attribute" alt="" coords="17,201,559,220"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#getChildren" title="Return all node's child nodes as list" alt="" coords="17,220,559,239"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#getData" title="Return all node CDATA as string (concatenated)" alt="" coords="17,239,559,257"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#getName" title="Return the name of node" alt="" coords="17,257,559,276"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#getNamespace" title="Return the namespace of node" alt="" coords="17,276,559,295"/>
<area shape="rect" id="node45" href="nbxmpp.simplexml.Node-class.html#__getattr__" title="Reduce memory usage caused by T/NT classes - use memory only when needed" alt="" coords="17,313,559,332"/>
<area shape="rect" id="node2" href="nbxmpp.simplexml.Node-class.html" title="Node class describes syntax of separate XML Node. It have a constructor that permits node creation from set of "namespace name", attributes and payload of text strings and other nodes. It does not natively support building node from text string and uses NodeBuilder class for that purpose. After creation node can be mangled in many ways so it can be completely changed. Also node can be serialised into string in one of two modes: default (where the textual representation of node describes it exactly) and "fancy" - with whitespace added to make indentation and thus make result more readable by human." alt="" coords="5,6,571,338"/>
</map>
<img src="uml_class_diagram_for_nbxmpp_p_3.gif" alt='' usemap="#uml_class_diagram_for_nbxmpp_p_3" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<body> tag that wraps usual XMPP stanzas in XMPP over BOSH
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="nbxmpp.protocol.BOSHBody-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">attrs</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
<span class="summary-sig-arg">payload</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
<span class="summary-sig-arg">node</span>=<span class="summary-sig-default">None</span>)</span><br />
Takes "tag" argument as the name of node (prepended by namespace, if
needed and separated from it by a space), attrs dictionary as the set of
arguments, payload list as the set of textual strings and child nodes
that this node carries within itself and "parent" argument that is
another node that this one will be the child of. Also the __init__ can be
provided with "node" argument that is either a text string containing
exactly one node or another Node instance to begin with. If both "node"
and other arguments is provided then the node initially created as
replica of "node" provided and then modified to be compliant with other
arguments.</td>
<td align="right" valign="top">
<span class="codelink"><a href="nbxmpp.protocol-pysrc.html#BOSHBody.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.simplexml.Node-class.html">simplexml.Node</a></code></b>:
<code><a href="nbxmpp.simplexml.Node-class.html#__contains__">__contains__</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#__delitem__">__delitem__</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#__getattr__">__getattr__</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#__getitem__">__getitem__</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#__setitem__">__setitem__</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#__str__">__str__</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#addChild">addChild</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#addData">addData</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#clearData">clearData</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#delAttr">delAttr</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#delChild">delChild</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getAttr">getAttr</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getAttrs">getAttrs</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getChildren">getChildren</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getData">getData</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getName">getName</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getNamespace">getNamespace</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getParent">getParent</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getPayload">getPayload</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getTag">getTag</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getTagAttr">getTagAttr</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getTagData">getTagData</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#getTags">getTags</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#has_attr">has_attr</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#iterTags">iterTags</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#lookup_nsp">lookup_nsp</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setAttr">setAttr</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setData">setData</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setName">setName</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setNamespace">setNamespace</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setParent">setParent</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setPayload">setPayload</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setTag">setTag</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setTagAttr">setTagAttr</a></code>,
<code><a href="nbxmpp.simplexml.Node-class.html#setTagData">setTagData</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="nbxmpp.simplexml.Node-class.html">simplexml.Node</a></code></b>:
<code><a href="nbxmpp.simplexml.Node-class.html#FORCE_NODE_RECREATION">FORCE_NODE_RECREATION</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">attrs</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>,
<span class="sig-arg">payload</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
<span class="sig-arg">node</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="nbxmpp.protocol-pysrc.html#BOSHBody.__init__">source code</a></span>
</td>
</tr></table>
Takes "tag" argument as the name of node (prepended by namespace, if
needed and separated from it by a space), attrs dictionary as the set of
arguments, payload list as the set of textual strings and child nodes
that this node carries within itself and "parent" argument that is
another node that this one will be the child of. Also the __init__ can be
provided with "node" argument that is either a text string containing
exactly one node or another Node instance to begin with. If both "node"
and other arguments is provided then the node initially created as
replica of "node" provided and then modified to be compliant with other
arguments.
<dl class="fields">
<dt>Overrides:
object.__init__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="nbxmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue May 8 11:18:05 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
