okhttp / okhttp3 / OkHttpClient

OkHttpClient

open class OkHttpClient :Cloneable, Factory, Factory

Factory for calls, which can be used to send HTTP requests and read their responses.

OkHttpClients Should Be Shared

OkHttp performs best when you create a single OkHttpClient instance and reuse it for all of your HTTP calls. This is because each client holds its own connection pool and thread pools. Reusing connections and threads reduces latency and saves memory. Conversely, creating a client for each request wastes resources on idle pools.

Use new OkHttpClient() to create a shared instance with the default settings:

// The singleton HTTP client.
public final OkHttpClient client = new OkHttpClient();

Or use new OkHttpClient.Builder() to create a shared instance with custom settings:

// The singleton HTTP client.
public final OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(new HttpLoggingInterceptor())
    .cache(new Cache(cacheDir, cacheSize))
    .build();

Customize Your Client With newBuilder()

You can customize a shared OkHttpClient instance with newBuilder. This builds a client that shares the same connection pool, thread pools, and configuration. Use the builder methods to configure the derived client for a specific purpose.

This example shows a call with a short 500 millisecond timeout:

OkHttpClient eagerClient = client.newBuilder()
    .readTimeout(500, TimeUnit.MILLISECONDS)
    .build();
Response response = eagerClient.newCall(request).execute();

Shutdown Isn’t Necessary

The threads and connections that are held will be released automatically if they remain idle. But if you are writing a application that needs to aggressively release unused resources you may do so.

Shutdown the dispatcher’s executor service with shutdown(). This will also cause future calls to the client to be rejected.

client.dispatcher().executorService().shutdown();

Clear the connection pool with evictAll(). Note that the connection pool’s daemon thread may not exit immediately.

client.connectionPool().evictAll();

If your client has a cache, call close(). Note that it is an error to create calls against a cache that is closed, and doing so will cause the call to crash.

client.cache().close();

OkHttp also uses daemon threads for HTTP/2 connections. These will exit automatically if they remain idle.

Types

Name Summary
Builder class Builder

Constructors

Name Summary
<init> OkHttpClient()

Properties

Name Summary
authenticator val authenticator:Authenticator
cache val cache:Cache?
callTimeoutMillis Default call timeout (in milliseconds). By default there is no timeout for complete calls, but there is for the connect, write, and read actions within a call.val callTimeoutMillis:Int
certificateChainCleaner val certificateChainCleaner: CertificateChainCleaner?
certificatePinner val certificatePinner:CertificatePinner
connectionPool val connectionPool:ConnectionPool
connectionSpecs val connectionSpecs:List<ConnectionSpec>
connectTimeoutMillis Default connect timeout (in milliseconds). The default is 10 seconds.val connectTimeoutMillis:Int
cookieJar val cookieJar:CookieJar
dispatcher val dispatcher:Dispatcher
dns val dns:Dns
eventListenerFactory val eventListenerFactory: Factory
followRedirects val followRedirects:Boolean
followSslRedirects val followSslRedirects:Boolean
hostnameVerifier val hostnameVerifier:HostnameVerifier
interceptors Returns an immutable list of interceptors that observe the full span of each call: from before the connection is established (if any) until after the response source is selected (either the origin server, cache, or both).val interceptors:List<Interceptor>
minWebSocketMessageToCompress Minimum outbound web socket message size (in bytes) that will be compressed. The default is 1024 bytes.val minWebSocketMessageToCompress:Long
networkInterceptors Returns an immutable list of interceptors that observe a single network request and response. These interceptors must call Interceptor.Chain.proceed exactly once: it is an error for a network interceptor to short-circuit or repeat a network request.val networkInterceptors:List<Interceptor>
pingIntervalMillis Web socket and HTTP/2 ping interval (in milliseconds). By default pings are not sent.val pingIntervalMillis:Int
protocols val protocols:List<Protocol>
proxy val proxy:Proxy?
proxyAuthenticator val proxyAuthenticator:Authenticator
proxySelector val proxySelector:ProxySelector
readTimeoutMillis Default read timeout (in milliseconds). The default is 10 seconds.val readTimeoutMillis:Int
retryOnConnectionFailure val retryOnConnectionFailure:Boolean
routeDatabase val routeDatabase: RouteDatabase
socketFactory val socketFactory:SocketFactory
sslSocketFactory val sslSocketFactory:SSLSocketFactory
writeTimeoutMillis Default write timeout (in milliseconds). The default is 10 seconds.val writeTimeoutMillis:Int
x509TrustManager val x509TrustManager:X509TrustManager?

Functions

Name Summary
newBuilder open fun newBuilder(): Builder
newCall Prepares the request to be executed at some point in the future.open fun newCall(request:Request):Call
newWebSocket Uses request to connect a new web socket.open fun newWebSocket(request:Request, listener:WebSocketListener):WebSocket