aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLorenz Diener <[email protected]>2018-06-05 17:37:11 +0200
committerLorenz Diener <[email protected]>2018-06-05 17:37:11 +0200
commit57520beea7ef83311be10be8acab4b34d2e10bf5 (patch)
tree13c4f26284756fda32332fb8e6e10d01886b27d4 /docs
parentcaba9c5467fb66fb722d6ebc94190ed093fc9d6a (diff)
downloadmastodon.py-57520beea7ef83311be10be8acab4b34d2e10bf5.tar.gz
Improve on_abort handler
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 56e0756..fc8c003 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -815,7 +815,8 @@ will return a handle corresponding to the open connection. If, in addition, `asy
815the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting 815the thread will attempt to reconnect to the streaming API if any errors are encountered, waiting
816`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made 816`async_reconnect_wait_sec` seconds between reconnection attempts. Note that no effort is made
817to "catch up" - events created while the connection is broken will not be received. If you need to make 817to "catch up" - events created while the connection is broken will not be received. If you need to make
818sure to get absolutely all notifications / deletes / toots, you will have to do that manually. 818sure to get absolutely all notifications / deletes / toots, you will have to do that manually, e.g.
819using the `on_abort` handler to fill in events since the last received one and then reconnecting.
819 820
820The connection may be closed at any time by calling the handles close() method. The 821The connection may be closed at any time by calling the handles close() method. The
821current status of the handler thread can be checked with the handles is_alive() function, 822current status of the handler thread can be checked with the handles is_alive() function,
Powered by cgit v1.2.3 (git 2.41.0)