aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/index.rst10
1 files changed, 6 insertions, 4 deletions
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
1257These functions allow access to the streaming API. For the public, local and hashtag streams, 1257These functions allow access to the streaming API. For the public, local and hashtag streams,
1258access is generally possible without authenticating. 1258access is generally possible without authenticating.
1259 1259
1260If `async` is False, these methods block forever (or until an error is encountered). 1260If `run_async` is False, these methods block forever (or until an error is encountered).
1261 1261
1262If `async` is True, the listener will listen on another thread and these methods 1262If `run_async` is True, the listener will listen on another thread and these methods
1263will return a handle corresponding to the open connection. If, in addition, `async_reconnect` is True, 1263will return a handle corresponding to the open connection. If, in addition, `reconnect_async` is True,
1264the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting 1264the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting
1265`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made 1265`reconnect_async_wait_sec` seconds between reconnection attempts. Note that no effort is made
1266to "catch up" - events created while the connection is broken will not be received. If you need to make 1266to "catch up" - events created while the connection is broken will not be received. If you need to make
1267sure to get absolutely all notifications / deletes / toots, you will have to do that manually, e.g. 1267sure to get absolutely all notifications / deletes / toots, you will have to do that manually, e.g.
1268using the `on_abort` handler to fill in events since the last received one and then reconnecting. 1268using the `on_abort` handler to fill in events since the last received one and then reconnecting.
1269Both `run_async` and `reconnect_async` default to false, and you'll have to set each to true
1270separately to get the behaviour described above.
1269 1271
1270The connection may be closed at any time by calling the handles close() method. The 1272The connection may be closed at any time by calling the handles close() method. The
1271current status of the handler thread can be checked with the handles is_alive() function, 1273current status of the handler thread can be checked with the handles is_alive() function,
Powered by cgit v1.2.3 (git 2.41.0)