Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document cancellation behaviour #7022

Closed
wants to merge 1 commit into from
Closed

Document cancellation behaviour #7022

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
9 changes: 9 additions & 0 deletions docs/calls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ Calls are executed in one of two ways:

Calls can be canceled from any thread. This will fail the call if it hasn’t yet completed! Code that is writing the request body or reading the response body will suffer an `IOException` when its call is canceled.

## Interrupts vs Cancellations

OkHttp is not currently interrupt safe. An interrupt in an execute call can result in a headers
frame being partially written to the connection. See https://github.com/square/okhttp/issues/7016.
After this the connection is in an unknown state.

Instead `call.cancel` or `body.close` should be used to cleanly cancel the request.
If an interrupt happens during reading the response body, then the response must still be closed.

## Dispatch

For synchronous calls, you bring your own thread and are responsible for managing how many simultaneous requests you make. Too many simultaneous connections wastes resources; too few harms latency.
Expand Down