spla/Mastodonplus.py
1
0
Fork 0
Codi Incidències Sol·licituds Pull Paquets Projectes Llançaments Wiki Activitat

Document new async behaviour a bit

Explorar la Font
This commit is contained in:
Lorenz Diener 2018-04-17 15:10:40 +02:00
pare eb336a30c2
commit 400faadc0d
S'han modificat 1 arxius amb 10 adicions i 6 eliminacions
Mostrar estadístiques Descarregar el fitxer de pedaç Descarregar el fitxer de diferències Expand all files Collapse all files

16
docs/index.rst
Veure arxiu

@ -725,13 +725,17 @@ Streaming
---------
These functions allow access to the streaming API.
If async is False, these methods block forever (or until an
exception is raised).
If `async` is False, these methods block forever (or until an exception is raised).
If async is True, the listener will listen on another thread and these methods
will return a handle corresponding to the open connection. The
connection may be closed at any time by calling the handles close() method, and the
status of the connection can be verified calling is_alive() on the handle.
If `async` is True, the listener will listen on another thread and these methods
will return a handle corresponding to the open connection. If, in addition, `async_reconnect` is True,
the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting
`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made
to "catch up" - toots made while the connection is broken will not be received.
The connection may be closed at any time by calling the handles close() method. The
current status of the handler thread can be checked with the handles is_alive() function,
and the streaming status can be checked by calling is_receiving().
The streaming functions take instances of `StreamListener` as the `listener` parameter.
A `CallbackStreamListener` class that allows you to specify function callbacks