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

Document streaming error handling

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

6
docs/index.rst
Veure arxiu

@ -725,7 +725,7 @@ 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 error is encountered).
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,
@ -741,6 +741,10 @@ The streaming functions take instances of `StreamListener` as the `listener` par
A `CallbackStreamListener` class that allows you to specify function callbacks
directly is included for convenience.
When in not-async mode or async mode without async_reconnect, the stream functions may raise
various exceptions: `MastodonMalformedEventError` if a received event cannot be parsed and
`MastodonNetworkError` if any connection problems occur.
.. automethod:: Mastodon.stream_user
.. automethod:: Mastodon.stream_public
.. automethod:: Mastodon.stream_local