Skip to content

Clarify Dispatcher custom executor requirements #9613

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

Merged
swankjesse merged 1 commit into from
Jul 27, 2026
+6 −2
Merged

Clarify Dispatcher custom executor requirements #9613

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
8 changes: 6 additions & 2 deletions okhttp/src/commonJvmAndroid/kotlin/okhttp3/Dispatcher.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,12 @@ import okhttp3.internal.unmodifiable
* Policy on when async requests are executed.
*
* Each dispatcher uses an [ExecutorService] to run calls internally. If you supply your own
* executor, it should be able to run [the configured maximum][maxRequests] number of calls
* concurrently.
* executor, it must accept new tasks while up to [the configured maximum][maxRequests] calls
* are already running. A pool sized exactly to [maxRequests] is not sufficient with a
* [SynchronousQueue], because the dispatcher may submit the next call from a worker that has
* not yet returned to the queue. Prefer the default pattern (`corePoolSize=0`,
* `maxPoolSize=Int.MAX_VALUE`, [SynchronousQueue]), a bound of about `2 * maxRequests`, or a
* queueing executor.
*/
class Dispatcher() {
/**
Expand Down
Loading