summaryrefslogtreecommitdiff
path: root/docs/using_asyncio.rst
diff options
context:
space:
mode:
authorEmmanuel Gil Peyrot <linkmauve@linkmauve.fr>2015-02-28 14:04:42 +0100
committerEmmanuel Gil Peyrot <linkmauve@linkmauve.fr>2015-04-04 16:48:30 +0200
commit632b7b4afe290d533189eff27482a43aec816076 (patch)
treecc9013c3647956f53153258b0a7ceeba2ad8737f /docs/using_asyncio.rst
parent0ef3fa2703933477e7b3579482cb2f90f639d3ca (diff)
downloadslixmpp-632b7b4afe290d533189eff27482a43aec816076.tar.gz
slixmpp-632b7b4afe290d533189eff27482a43aec816076.tar.bz2
slixmpp-632b7b4afe290d533189eff27482a43aec816076.tar.xz
slixmpp-632b7b4afe290d533189eff27482a43aec816076.zip
XMLStream: add a forever parameter to process(), defaulting to True, to select whether we want to stop the event loop after a disconnection
Diffstat (limited to 'docs/using_asyncio.rst')
-rw-r--r--docs/using_asyncio.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/using_asyncio.rst b/docs/using_asyncio.rst
index c84148e8..55ed7679 100644
--- a/docs/using_asyncio.rst
+++ b/docs/using_asyncio.rst
@@ -53,7 +53,8 @@ Running the event loop
:meth:`.XMLStream.process` is only a thin wrapper on top of
``loop.run_forever()`` (if ``timeout`` is provided then it will
-only run for this amount of time).
+only run for this amount of time, and if ``forever`` is False it will
+run until disconnection).
Therefore you can handle the event loop in any way you like
instead of using ``process()``.