Skip to content

Clarify Dispatcher executor sizing requirements in KDoc #9454

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

Open
leno23 wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −2
Open

Clarify Dispatcher executor sizing requirements in KDoc #9454

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
10 changes: 8 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,14 @@ 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 any new task at any time while up to [the configured maximum][maxRequests]
* calls are already running. A pool sized exactly to `maxRequests` is not sufficient when paired
* with [SynchronousQueue], because the dispatcher submits the next promoted call from a worker
* thread that has not yet returned to the queue; the offer will fail and the call will surface
* [InterruptedIOException] with message `"executor rejected"`.
*
* Match the pattern used by the default executor (`corePoolSize=0`, `maxPoolSize=Int.MAX_VALUE`,
* [SynchronousQueue]), bound the maximum at `2 × maxRequests`, or use a queueing executor.
*/
class Dispatcher() {
/**
Expand Down
Loading