OkHttpClient (OkHttp 3.5.0 API)

java.lang.Object
- okhttp3.OkHttpClient

All Implemented Interfaces:

Cloneable, Call.Factory, WebSocket.Factory
```
public class OkHttpClient
extends Object
implements Cloneable, Call.Factory, WebSocket.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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OkHttpClient.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`OkHttpClient.Builder`

Constructor Summary

Constructors
Constructor and Description

OkHttpClient()

Constructors
Constructor and Description
`OkHttpClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authenticator`	`authenticator()`
`Cache`	`cache()`
`CertificatePinner`	`certificatePinner()`
`ConnectionPool`	`connectionPool()`
`List<ConnectionSpec>`	`connectionSpecs()`
`int`	`connectTimeoutMillis()` Default connect timeout (in milliseconds).
`CookieJar`	`cookieJar()`
`Dispatcher`	`dispatcher()`
`Dns`	`dns()`
`boolean`	`followRedirects()`
`boolean`	`followSslRedirects()`
`HostnameVerifier`	`hostnameVerifier()`
`List<Interceptor>`	`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).
`List<Interceptor>`	`networkInterceptors()` Returns an immutable list of interceptors that observe a single network request and response.
`OkHttpClient.Builder`	`newBuilder()`
`Call`	`newCall(Request request)` Prepares the `request` to be executed at some point in the future.
`WebSocket`	`newWebSocket(Request request, WebSocketListener listener)` Uses `request` to connect a new web socket.
`int`	`pingIntervalMillis()` Web socket ping interval (in milliseconds).
`List<Protocol>`	`protocols()`
`Proxy`	`proxy()`
`Authenticator`	`proxyAuthenticator()`
`ProxySelector`	`proxySelector()`
`int`	`readTimeoutMillis()` Default read timeout (in milliseconds).
`boolean`	`retryOnConnectionFailure()`
`SocketFactory`	`socketFactory()`
`SSLSocketFactory`	`sslSocketFactory()`
`int`	`writeTimeoutMillis()` Default write timeout (in milliseconds).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OkHttpClient
```
public OkHttpClient()
```
- Method Detail
  - connectTimeoutMillis
```
public int connectTimeoutMillis()
```
    Default connect timeout (in milliseconds).
  - readTimeoutMillis
```
public int readTimeoutMillis()
```
    Default read timeout (in milliseconds).
  - writeTimeoutMillis
```
public int writeTimeoutMillis()
```
    Default write timeout (in milliseconds).
  - pingIntervalMillis
```
public int pingIntervalMillis()
```
    Web socket ping interval (in milliseconds).
  - proxy
```
public Proxy proxy()
```
  - proxySelector
```
public ProxySelector proxySelector()
```
  - cookieJar
```
public CookieJar cookieJar()
```
  - cache
```
public Cache cache()
```
  - dns
```
public Dns dns()
```
  - socketFactory
```
public SocketFactory socketFactory()
```
  - sslSocketFactory
```
public SSLSocketFactory sslSocketFactory()
```
  - hostnameVerifier
```
public HostnameVerifier hostnameVerifier()
```
  - certificatePinner
```
public CertificatePinner certificatePinner()
```
  - authenticator
```
public Authenticator authenticator()
```
  - proxyAuthenticator
```
public Authenticator proxyAuthenticator()
```
  - connectionPool
```
public ConnectionPool connectionPool()
```
  - followSslRedirects
```
public boolean followSslRedirects()
```
  - followRedirects
```
public boolean followRedirects()
```
  - retryOnConnectionFailure
```
public boolean retryOnConnectionFailure()
```
  - dispatcher
```
public Dispatcher dispatcher()
```
  - protocols
```
public List<Protocol> protocols()
```
  - connectionSpecs
```
public List<ConnectionSpec> connectionSpecs()
```
  - interceptors
```
public List<Interceptor> 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).
  - networkInterceptors
```
public List<Interceptor> networkInterceptors()
```
    Returns an immutable list of interceptors that observe a single network request and response. These interceptors must call Interceptor.Chain.proceed(okhttp3.Request) exactly once: it is an error for a network interceptor to short-circuit or repeat a network request.
  - newCall
```
public Call newCall(Request request)
```
    Prepares the request to be executed at some point in the future.
    
    Specified by:
    
    newCall in interface Call.Factory
  - newWebSocket
```
public WebSocket newWebSocket(Request request,
                              WebSocketListener listener)
```
    Uses request to connect a new web socket.
    
    Specified by:
    
    newWebSocket in interface WebSocket.Factory
  - newBuilder
```
public OkHttpClient.Builder newBuilder()
```

Class OkHttpClient

OkHttpClients should be shared

Customize your client with newBuilder()

Shutdown isn't necessary

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OkHttpClient

Method Detail

connectTimeoutMillis

readTimeoutMillis

writeTimeoutMillis

pingIntervalMillis

proxy

proxySelector

cookieJar

cache

dns

socketFactory

sslSocketFactory

hostnameVerifier

certificatePinner

authenticator

proxyAuthenticator

connectionPool

followSslRedirects

followRedirects

retryOnConnectionFailure

dispatcher

protocols

connectionSpecs

interceptors

networkInterceptors

newCall

newWebSocket

newBuilder