Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

docs: explain that future.cancel() is non-blocking #420

Merged
plamut merged 1 commit into from
Jun 11, 2021
Merged

docs: explain that future.cancel() is non-blocking #420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions google/cloud/pubsub_v1/subscriber/futures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ def _on_close_callback(self, manager, result):
def cancel(self):
"""Stops pulling messages and shutdowns the background thread consuming
messages.

.. versionchanged:: 2.4.1
The method does not block anymore, it just triggers the shutdown and returns
immediately. To block until the background stream is terminated, call
:meth:`result()` after cancelling the future.
"""
# NOTE: We circumvent the base future's self._state to track the cancellation
# state, as this state has different meaning with streaming pull futures.
Expand Down