From c448dc99fe46fa9709cf0eb866bc4347abdfa8c7 Mon Sep 17 00:00:00 2001 From: halcy Date: Sun, 6 Nov 2022 14:51:00 +0200 Subject: update docs a bit --- docs/index.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index e7b1ed9..d88ecc4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1257,15 +1257,17 @@ Streaming These functions allow access to the streaming API. For the public, local and hashtag streams, 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 -will return a handle corresponding to the open connection. If, in addition, `async_reconnect` is True, +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, `reconnect_async` 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 +`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 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. +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 current status of the handler thread can be checked with the handles is_alive() function, -- cgit v1.2.3