okhttp / okhttp3 / Dispatcher

Dispatcher

class Dispatcher

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 number of calls concurrently.

Constructors

Name Summary
<init> Dispatcher(executorService:ExecutorService)
Policy on when async requests are executed.Dispatcher()

Properties

Name Summary
executorService val executorService:ExecutorService
idleCallback A callback to be invoked each time the dispatcher becomes idle (when the number of running calls returns to zero).var idleCallback:Runnable?
maxRequests The maximum number of requests to execute concurrently. Above this requests queue in memory, waiting for the running calls to complete.var maxRequests:Int
maxRequestsPerHost The maximum number of requests for each host to execute concurrently. This limits requests by the URL’s host name. Note that concurrent requests to a single IP address may still exceed this limit: multiple hostnames may share an IP address or be routed through the same HTTP proxy.var maxRequestsPerHost:Int

Functions

Name Summary
cancelAll Cancel all calls currently enqueued or executing. Includes calls executed both synchronously and asynchronously.fun cancelAll():Unit
queuedCalls Returns a snapshot of the calls currently awaiting execution.fun queuedCalls():List<Call>
queuedCallsCount fun queuedCallsCount():Int
runningCalls Returns a snapshot of the calls currently being executed.fun runningCalls():List<Call>
runningCallsCount fun runningCallsCount():Int