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