mirror
/
Mastodon.py
kopia lustrzana https://github.com/halcy/Mastodon.py
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

update docs a bit

pull/252/head
halcy 2022-11-06 14:51:00 +02:00
rodzic a5eac05ea2
commit c448dc99fe
1 zmienionych plików z 6 dodań i 4 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

10
docs/index.rst
Wyświetl plik

@ -1257,15 +1257,17 @@ Streaming
These functions allow access to the streaming API. For the public, local and hashtag streams, These functions allow access to the streaming API. For the public, local and hashtag streams,
access is generally possible without authenticating. access is generally possible without authenticating.
If `async` is False, these methods block forever (or until an error is encountered). If `run_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 If `run_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, will return a handle corresponding to the open connection. If, in addition, `reconnect_async` is True,
the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting 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 `reconnect_async_wait_sec` seconds between reconnection attempts. Note that no effort is made
to "catch up" - events created while the connection is broken will not be received. If you need to make to "catch up" - events created while the connection is broken will not be received. If you need to make
sure to get absolutely all notifications / deletes / toots, you will have to do that manually, e.g. sure to get absolutely all notifications / deletes / toots, you will have to do that manually, e.g.
using the `on_abort` handler to fill in events since the last received one and then reconnecting. using the `on_abort` handler to fill in events since the last received one and then reconnecting.
Both `run_async` and `reconnect_async` default to false, and you'll have to set each to true
separately to get the behaviour described above.
The connection may be closed at any time by calling the handles close() method. The 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, current status of the handler thread can be checked with the handles is_alive() function,