/usr/share/doc/python-slixmpp-doc/html/api/xmlstream/xmlstream.html is in python-slixmpp-doc 1.2.2-1.1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>XML Stream — slixmpp</title>
<link rel="stylesheet" href="../../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="XML Serialization" href="tostring.html" />
<link rel="prev" title="Stanza Matchers" href="matcher.html" />
</head>
<body role="document">
<div class="header" role="banner"><h1 class="heading"><a href="../../index.html">
<span>1.1 Documentation</span></a></h1>
<h2 class="heading"><span>XML Stream</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="matcher.html">Stanza Matchers</a>
  ::  
<a class="uplink" href="../../index.html">Contents</a>
  ::  
<a href="tostring.html">XML Serialization</a>  »
</p>
</div>
<div class="content">
<div class="section" id="module-slixmpp.xmlstream.xmlstream">
<span id="xml-stream"></span><h1>XML Stream<a class="headerlink" href="#module-slixmpp.xmlstream.xmlstream" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream">
<em class="property">class </em><code class="descclassname">slixmpp.xmlstream.xmlstream.</code><code class="descname">XMLStream</code><span class="sig-paren">(</span><em>socket=None</em>, <em>host=''</em>, <em>port=0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream" title="Permalink to this definition">¶</a></dt>
<dd><p>An XML stream connection manager and event dispatcher.</p>
<p>The XMLStream class abstracts away the issues of establishing a
connection with a server and sending and receiving XML “stanzas”.
A stanza is a complete XML element that is a direct child of a root
document element. Two streams are used, one for each communication
direction, over the same socket. Once the connection is closed, both
streams should be complete and valid XML documents.</p>
<dl class="docutils">
<dt>Three types of events are provided to manage the stream:</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Stream:</th><td class="field-body">Triggered based on received stanzas, similar in concept
to events in a SAX XML parser.</td>
</tr>
<tr class="field-even field"><th class="field-name">Custom:</th><td class="field-body">Triggered manually.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Scheduled:</th><td class="field-body">Triggered based on time delays.</td>
</tr>
</tbody>
</table>
</dd>
</dl>
<p>Typically, stanzas are first processed by a stream event handler which
will then trigger custom events to continue further processing,
especially since custom event handlers may run in individual threads.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>socket</strong> – Use an existing socket for the stream. Defaults to
<code class="docutils literal"><span class="pre">None</span></code> to generate a new socket.</li>
<li><strong>host</strong> (<em>string</em>) – The name of the target server.</li>
<li><strong>port</strong> (<em>int</em>) – The port to use for the connection. Defaults to 0.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.abort">
<code class="descname">abort</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.abort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.abort" title="Permalink to this definition">¶</a></dt>
<dd><p>Forcibly close the connection</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.add_event_handler">
<code class="descname">add_event_handler</code><span class="sig-paren">(</span><em>name</em>, <em>pointer</em>, <em>disposable=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.add_event_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.add_event_handler" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a custom event handler that will be executed whenever
its event is manually triggered.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the event that will trigger
this handler.</li>
<li><strong>pointer</strong> – The function to execute.</li>
<li><strong>disposable</strong> – If set to <code class="docutils literal"><span class="pre">True</span></code>, the handler will be
discarded after one use. Defaults to <code class="docutils literal"><span class="pre">False</span></code>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.add_filter">
<code class="descname">add_filter</code><span class="sig-paren">(</span><em>mode</em>, <em>handler</em>, <em>order=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.add_filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.add_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a filter for incoming or outgoing stanzas.</p>
<p>These filters are applied before incoming stanzas are
passed to any handlers, and before outgoing stanzas
are put in the send queue.</p>
<p>Each filter must accept a single stanza, and return
either a stanza or <code class="docutils literal"><span class="pre">None</span></code>. If the filter returns
<code class="docutils literal"><span class="pre">None</span></code>, then the stanza will be dropped from being
processed for events or from being sent.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>mode</strong> – One of <code class="docutils literal"><span class="pre">'in'</span></code> or <code class="docutils literal"><span class="pre">'out'</span></code>.</li>
<li><strong>handler</strong> – The filter function.</li>
<li><strong>order</strong> (<em>int</em>) – The position to insert the filter in
the list of active filters.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.address">
<code class="descname">address</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.address" title="Permalink to this definition">¶</a></dt>
<dd><p>The desired, or actual, address of the connected server.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.ca_certs">
<code class="descname">ca_certs</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.ca_certs" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to a file containing certificates for verifying the
server SSL certificate. A non-<code class="docutils literal"><span class="pre">None</span></code> value will trigger
certificate checking.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">On Mac OS X, certificates in the system keyring will
be consulted, even if they are not in the provided file.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.certfile">
<code class="descname">certfile</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.certfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to a file containing a client certificate to use for
authenticating via SASL EXTERNAL. If set, there must also
be a corresponding <cite>:attr:keyfile</cite> value.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.ciphers">
<code class="descname">ciphers</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.ciphers" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of accepted ciphers, in OpenSSL Format.
It might be useful to override it for improved security
over the python defaults.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.configure_dns">
<code class="descname">configure_dns</code><span class="sig-paren">(</span><em>resolver</em>, <em>domain=None</em>, <em>port=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.configure_dns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.configure_dns" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure and set options for a <code class="xref py py-class docutils literal"><span class="pre">Resolver</span></code>
instance, and other DNS related tasks. For example, you
can also check <code class="xref py py-meth docutils literal"><span class="pre">getaddrinfo()</span></code> to see
if you need to call out to <code class="docutils literal"><span class="pre">libresolv.so.2</span></code> to
run <code class="docutils literal"><span class="pre">res_init()</span></code>.</p>
<p>Meant to be overridden.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>resolver</strong> – A <code class="xref py py-class docutils literal"><span class="pre">Resolver</span></code> instance
or <code class="docutils literal"><span class="pre">None</span></code> if <code class="docutils literal"><span class="pre">dnspython</span></code> is not installed.</li>
<li><strong>domain</strong> – The initial domain under consideration.</li>
<li><strong>port</strong> – The initial port under consideration.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.configure_socket">
<code class="descname">configure_socket</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.configure_socket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.configure_socket" title="Permalink to this definition">¶</a></dt>
<dd><p>Set timeout and other options for self.socket.</p>
<p>Meant to be overridden.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.connect">
<code class="descname">connect</code><span class="sig-paren">(</span><em>host=''</em>, <em>port=0</em>, <em>use_ssl=False</em>, <em>force_starttls=True</em>, <em>disable_starttls=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new socket and connect to the server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>host</strong> – The name of the desired server for the connection.</li>
<li><strong>port</strong> – Port to connect to on the server.</li>
<li><strong>use_ssl</strong> – Flag indicating if SSL should be used by connecting
directly to a port using SSL. If it is False, the
connection will be upgraded to SSL/TLS later, using
STARTTLS. Only use this value for old servers that
have specific port for SSL/TLS</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>TODO fix the comment
:param force_starttls: If True, the connection will be aborted if</p>
<blockquote>
<div>the server does not initiate a STARTTLS
negotiation. If None, the connection will be
upgraded to TLS only if the server initiate
the STARTTLS negotiation, otherwise it will
connect in clear. If False it will never
upgrade to TLS, even if the server provides
it. Use this for example if you’re on
localhost</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.connection_lost">
<code class="descname">connection_lost</code><span class="sig-paren">(</span><em>exception</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.connection_lost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.connection_lost" title="Permalink to this definition">¶</a></dt>
<dd><p>On any kind of disconnection, initiated by us or not. This signals the
closure of the TCP connection</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.connection_made">
<code class="descname">connection_made</code><span class="sig-paren">(</span><em>transport</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.connection_made"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.connection_made" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when the TCP connection has been established with the server</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.data_received">
<code class="descname">data_received</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.data_received"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.data_received" title="Permalink to this definition">¶</a></dt>
<dd><p>Called when incoming data is received on the socket.</p>
<p>We feed that data to the parser and the see if this produced any XML
event. This could trigger one or more event (a stanza is received,
the stream is opened, etc).</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.default_domain">
<code class="descname">default_domain</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.default_domain" title="Permalink to this definition">¶</a></dt>
<dd><p>The domain to try when querying DNS records.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.default_ns">
<code class="descname">default_ns</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.default_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>The default namespace of the stream content, not of the
stream wrapper itself.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.default_port">
<code class="descname">default_port</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.default_port" title="Permalink to this definition">¶</a></dt>
<dd><p>The default port to return when querying DNS records.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.del_event_handler">
<code class="descname">del_event_handler</code><span class="sig-paren">(</span><em>name</em>, <em>pointer</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.del_event_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.del_event_handler" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a function as a handler for an event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the event.</li>
<li><strong>pointer</strong> – The function to remove as a handler.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.del_filter">
<code class="descname">del_filter</code><span class="sig-paren">(</span><em>mode</em>, <em>handler</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.del_filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.del_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove an incoming or outgoing filter.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>wait=2.0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>Close the XML stream and wait for an acknowldgement from the server for
at most <cite>wait</cite> seconds. After the given number of seconds has
passed without a response from the serveur, or when the server
successfuly responds with a closure of its own stream, abort() is
called. If wait is 0.0, this is almost equivalent to calling abort()
directly.</p>
<p>Does nothing if we are not connected.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wait</strong> – Time to wait for a response from the server.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.disconnected">
<code class="descname">disconnected</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.disconnected" title="Permalink to this definition">¶</a></dt>
<dd><p>An asyncio Future being done when the stream is disconnected.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.dns_answers">
<code class="descname">dns_answers</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.dns_answers" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of DNS results that have not yet been tried.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.dns_service">
<code class="descname">dns_service</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.dns_service" title="Permalink to this definition">¶</a></dt>
<dd><p>The service name to check with DNS SRV records. For
example, setting this to <code class="docutils literal"><span class="pre">'xmpp-client'</span></code> would query the
<code class="docutils literal"><span class="pre">_xmpp-client._tcp</span></code> service.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.end_session_on_disconnect">
<code class="descname">end_session_on_disconnect</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.end_session_on_disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>Flag for controlling if the session can be considered ended
if the connection is terminated.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.eof_received">
<code class="descname">eof_received</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.eof_received"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.eof_received" title="Permalink to this definition">¶</a></dt>
<dd><p>When the TCP connection is properly closed by the remote end</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.event">
<code class="descname">event</code><span class="sig-paren">(</span><em>name</em>, <em>data={}</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.event" title="Permalink to this definition">¶</a></dt>
<dd><p>Manually trigger a custom event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – The name of the event to trigger.</li>
<li><strong>data</strong> – Data that will be passed to each event handler.
Defaults to an empty dictionary, but is usually
a stanza object.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.event_handled">
<code class="descname">event_handled</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.event_handled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.event_handled" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the number of registered handlers for an event.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – The name of the event to check.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.exception">
<code class="descname">exception</code><span class="sig-paren">(</span><em>exception</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.exception"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.exception" title="Permalink to this definition">¶</a></dt>
<dd><p>Process an unknown exception.</p>
<p>Meant to be overridden.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exception</strong> – An unhandled exception object.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.get_dns_records">
<code class="descname">get_dns_records</code><span class="sig-paren">(</span><em>domain</em>, <em>port=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.get_dns_records"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.get_dns_records" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the DNS records for a domain.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> – The domain in question.</li>
<li><strong>port</strong> – If the results don’t include a port, use this one.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.get_id">
<code class="descname">get_id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.get_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the current unique stream ID in hexadecimal form.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.incoming_filter">
<code class="descname">incoming_filter</code><span class="sig-paren">(</span><em>xml</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.incoming_filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.incoming_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Filter incoming XML objects before they are processed.</p>
<p>Possible uses include remapping namespaces, or correcting elements
from sources with incorrect behavior.</p>
<p>Meant to be overridden.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.init_parser">
<code class="descname">init_parser</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.init_parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.init_parser" title="Permalink to this definition">¶</a></dt>
<dd><p>init the XML parser. The parser must always be reset for each new
connexion</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.keyfile">
<code class="descname">keyfile</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.keyfile" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to a file containing the private key for the selected
client certificate to use for authenticating via SASL EXTERNAL.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.namespace_map">
<code class="descname">namespace_map</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.namespace_map" title="Permalink to this definition">¶</a></dt>
<dd><p>A mapping of XML namespaces to well-known prefixes.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.new_id">
<code class="descname">new_id</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.new_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.new_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate and return a new stream ID in hexadecimal form.</p>
<p>Many stanzas, handlers, or matchers may require unique
ID values. Using this method ensures that all new ID values
are unique in this stream.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.pick_dns_answer">
<code class="descname">pick_dns_answer</code><span class="sig-paren">(</span><em>domain</em>, <em>port=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.pick_dns_answer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.pick_dns_answer" title="Permalink to this definition">¶</a></dt>
<dd><p>Pick a server and port from DNS answers.</p>
<p>Gets DNS answers if none available.
Removes used answer from available answers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> – The domain in question.</li>
<li><strong>port</strong> – If the results don’t include a port, use this one.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.process">
<code class="descname">process</code><span class="sig-paren">(</span><em>*</em>, <em>forever=True</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.process" title="Permalink to this definition">¶</a></dt>
<dd><p>Process all the available XMPP events (receiving or sending data on the
socket(s), calling various registered callbacks, calling expired
timers, handling signal events, etc). If timeout is None, this
function will run forever. If timeout is a number, this function
will return after the given time in seconds.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.proxy_config">
<code class="descname">proxy_config</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.proxy_config" title="Permalink to this definition">¶</a></dt>
<dd><p>An optional dictionary of proxy settings. It may provide:
:host: The host offering proxy services.
:port: The port for the proxy service.
:username: Optional username for accessing the proxy.
:password: Optional password for accessing the proxy.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.reconnect">
<code class="descname">reconnect</code><span class="sig-paren">(</span><em>wait=2.0</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.reconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.reconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>Calls disconnect(), and once we are disconnected (after the timeout, or
when the server acknowledgement is received), call connect()</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.register_handler">
<code class="descname">register_handler</code><span class="sig-paren">(</span><em>handler</em>, <em>before=None</em>, <em>after=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.register_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.register_handler" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a stream event handler that will be executed when a matching
stanza is received.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>handler</strong> – The <a class="reference internal" href="handler.html#slixmpp.xmlstream.handler.base.BaseHandler" title="slixmpp.xmlstream.handler.base.BaseHandler"><code class="xref py py-class docutils literal"><span class="pre">BaseHandler</span></code></a>
derived object to execute.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.register_stanza">
<code class="descname">register_stanza</code><span class="sig-paren">(</span><em>stanza_class</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.register_stanza"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.register_stanza" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a stanza object class as a known root stanza.</p>
<p>A root stanza is one that appears as a direct child of the stream’s
root element.</p>
<p>Stanzas that appear as substanzas of a root stanza do not need to
be registered here. That is done using register_stanza_plugin() from
slixmpp.xmlstream.stanzabase.</p>
<p>Stanzas that are not registered will not be converted into
stanza objects, but may still be processed using handlers and
matchers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stanza_class</strong> – The top-level stanza object’s class.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.remove_handler">
<code class="descname">remove_handler</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.remove_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.remove_handler" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove any stream event handlers with the given name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – The name of the handler.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.remove_stanza">
<code class="descname">remove_stanza</code><span class="sig-paren">(</span><em>stanza_class</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.remove_stanza"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.remove_stanza" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a stanza from being a known root stanza.</p>
<p>A root stanza is one that appears as a direct child of the stream’s
root element.</p>
<p>Stanzas that are not registered will not be converted into
stanza objects, but may still be processed using handlers and
matchers.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.schedule">
<code class="descname">schedule</code><span class="sig-paren">(</span><em>name</em>, <em>seconds</em>, <em>callback</em>, <em>args=()</em>, <em>kwargs={}</em>, <em>repeat=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.schedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.schedule" title="Permalink to this definition">¶</a></dt>
<dd><p>Schedule a callback function to execute after a given delay.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – A unique name for the scheduled callback.</li>
<li><strong>seconds</strong> – The time in seconds to wait before executing.</li>
<li><strong>callback</strong> – A pointer to the function to execute.</li>
<li><strong>args</strong> – A tuple of arguments to pass to the function.</li>
<li><strong>kwargs</strong> – A dictionary of keyword arguments to pass to
the function.</li>
<li><strong>repeat</strong> – Flag indicating if the scheduled event should
be reset and repeat after executing.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.send">
<code class="descname">send</code><span class="sig-paren">(</span><em>data</em>, <em>use_filters=True</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.send" title="Permalink to this definition">¶</a></dt>
<dd><p>A wrapper for <a class="reference internal" href="#slixmpp.xmlstream.xmlstream.XMLStream.send_raw" title="slixmpp.xmlstream.xmlstream.XMLStream.send_raw"><code class="xref py py-meth docutils literal"><span class="pre">send_raw()</span></code></a> for sending stanza objects.</p>
<p>May optionally block until an expected response is received.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>data</strong> – The <a class="reference internal" href="stanzabase.html#slixmpp.xmlstream.stanzabase.ElementBase" title="slixmpp.xmlstream.stanzabase.ElementBase"><code class="xref py py-class docutils literal"><span class="pre">ElementBase</span></code></a>
stanza to send on the stream.</li>
<li><strong>use_filters</strong> (<em>bool</em>) – Indicates if outgoing filters should be
applied to the given stanza data. Disabling
filters is useful when resending stanzas.
Defaults to <code class="docutils literal"><span class="pre">True</span></code>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.send_raw">
<code class="descname">send_raw</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.send_raw"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.send_raw" title="Permalink to this definition">¶</a></dt>
<dd><p>Send raw data across the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>string</em>) – Any bytes or utf-8 string value.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.send_xml">
<code class="descname">send_xml</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.send_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.send_xml" title="Permalink to this definition">¶</a></dt>
<dd><p>Send an XML object on the stream</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – The <code class="xref py py-class docutils literal"><span class="pre">Element</span></code> XML object
to send on the stream.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.start_stream_handler">
<code class="descname">start_stream_handler</code><span class="sig-paren">(</span><em>xml</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.start_stream_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.start_stream_handler" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform any initialization actions, such as handshakes,
once the stream header has been sent.</p>
<p>Meant to be overridden.</p>
</dd></dl>
<dl class="method">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.start_tls">
<code class="descname">start_tls</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/slixmpp/xmlstream/xmlstream.html#XMLStream.start_tls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.start_tls" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform handshakes for TLS.</p>
<p>If the handshake is successful, the XML stream will need
to be restarted.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.stream_footer">
<code class="descname">stream_footer</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.stream_footer" title="Permalink to this definition">¶</a></dt>
<dd><p>The default closing tag for the stream element.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.stream_header">
<code class="descname">stream_header</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.stream_header" title="Permalink to this definition">¶</a></dt>
<dd><p>The default opening tag for the stream element.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.stream_ns">
<code class="descname">stream_ns</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.stream_ns" title="Permalink to this definition">¶</a></dt>
<dd><p>The namespace of the enveloping stream element.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.use_aiodns">
<code class="descname">use_aiodns</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.use_aiodns" title="Permalink to this definition">¶</a></dt>
<dd><p>If set to <code class="docutils literal"><span class="pre">True</span></code>, allow using the <code class="docutils literal"><span class="pre">dnspython</span></code> DNS library
if available. If set to <code class="docutils literal"><span class="pre">False</span></code>, the builtin DNS resolver
will be used, even if <code class="docutils literal"><span class="pre">dnspython</span></code> is installed.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.use_cdata">
<code class="descname">use_cdata</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.use_cdata" title="Permalink to this definition">¶</a></dt>
<dd><p>Use CDATA for escaping instead of XML entities. Defaults
to <code class="docutils literal"><span class="pre">False</span></code>.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.use_ipv6">
<code class="descname">use_ipv6</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.use_ipv6" title="Permalink to this definition">¶</a></dt>
<dd><p>If set to <code class="docutils literal"><span class="pre">True</span></code>, attempt to use IPv6.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.use_proxy">
<code class="descname">use_proxy</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.use_proxy" title="Permalink to this definition">¶</a></dt>
<dd><p>If set to <code class="docutils literal"><span class="pre">True</span></code>, attempt to connect through an HTTP
proxy based on the settings in <a class="reference internal" href="#slixmpp.xmlstream.xmlstream.XMLStream.proxy_config" title="slixmpp.xmlstream.xmlstream.XMLStream.proxy_config"><code class="xref py py-attr docutils literal"><span class="pre">proxy_config</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.use_ssl">
<code class="descname">use_ssl</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.use_ssl" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable connecting to the server directly over SSL, in
particular when the service provides two ports: one for
non-SSL traffic and another for SSL traffic.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.whitespace_keepalive">
<code class="descname">whitespace_keepalive</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.whitespace_keepalive" title="Permalink to this definition">¶</a></dt>
<dd><p>If <code class="docutils literal"><span class="pre">True</span></code>, periodically send a whitespace character over the
wire to keep the connection alive. Mainly useful for connections
traversing NAT.</p>
</dd></dl>
<dl class="attribute">
<dt id="slixmpp.xmlstream.xmlstream.XMLStream.whitespace_keepalive_interval">
<code class="descname">whitespace_keepalive_interval</code><em class="property"> = None</em><a class="headerlink" href="#slixmpp.xmlstream.xmlstream.XMLStream.whitespace_keepalive_interval" title="Permalink to this definition">¶</a></dt>
<dd><p>The default interval between keepalive signals when
<a class="reference internal" href="#slixmpp.xmlstream.xmlstream.XMLStream.whitespace_keepalive" title="slixmpp.xmlstream.xmlstream.XMLStream.whitespace_keepalive"><code class="xref py py-attr docutils literal"><span class="pre">whitespace_keepalive</span></code></a> is enabled.</p>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="matcher.html">Stanza Matchers</a>
  ::  
<a class="uplink" href="../../index.html">Contents</a>
  ::  
<a href="tostring.html">XML Serialization</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017, Nathan Fritz, Lance Stout.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
|