How to set connection timeout with OkHttp

Question

I am developing app using OkHttp library and my trouble is I cannot find how to set connection timeout and socket timeout.

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder().url(url).build();

Response response = client.newCall(request).execute();

The answer you selected is no longer valid. Maybe you should edit question to specify version of okhttp. — BillHaggerty, Jan 27 '16 at 22:34

score 400 · Accepted Answer · edited Feb 22 '21 at 10:09

400

As of OkHttp3 you can do this through the Builder like so

client = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)
    .writeTimeout(10, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .build();

You can also view the recipe here.

For older versions, you simply have to do this

OkHttpClient client = new OkHttpClient();
client.setConnectTimeout(15, TimeUnit.SECONDS); // connect timeout
client.setReadTimeout(15, TimeUnit.SECONDS);    // socket timeout

Request request = new Request.Builder().url(url).build();
Response response = client.newCall(request).execute();

Be aware that value set in setReadTimeout is the one used in setSoTimeout on the Socket internally in the OkHttp Connection class.

Not setting any timeout on the OkHttpClient is the equivalent of setting a value of 0 on setConnectTimeout or setReadTimeout and will result in no timeout at all. Description can be found here.

As mentioned by @marceloquinta in the comments setWriteTimeout can also be set.

As of version 2.5.0 read / write / connect timeout values are set to 10 seconds by default as mentioned by @ChristerNordvik. This can be seen here.

edited Feb 22 '21 at 10:09

Ryan Lundy

204,559
37
180
211

answered Sep 22 '14 at 12:08

Miguel

19,793
8
56
46

11

Is there a way to set those timeout different for each request (each request has the same static client)? – StErMi Nov 28 '14 at 14:41
3

You can set specific timeout for each request : Here some information : https://github.com/square/okhttp/wiki/Recipes – Tobliug Feb 11 '15 at 17:18
@MiguelLavigne If no timeout was set , is there a default timeout or no timeout at all ? – EviatarS Aug 25 '15 at 09:03
1

@EviatarS I've updated the answer with that information. Good luck! – Miguel Aug 25 '15 at 15:01
3

Dont forget the WRITE timeout: client.setWriteTimeout(10, TimeUnit.SECONDS); – marceloquinta Sep 21 '15 at 00:28
8

@MiguelLavigne Just FYI, OkHttp changed in 2.5.0 to have a default timeout of 10 sec. – Christer Nordvik Dec 12 '15 at 15:41
@What if `client.call(...)` itself time's out. It stops my entire loop. If the call times out, I need it to break and continue the loop. – dbconfession Aug 28 '16 at 19:27
7

Outdated Answer – devDeejay Jan 31 '18 at 20:34
@MiguelLavigne, there are default timeouts. 10 seconds for connecting and 10 seconds for reading. See the docs: https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html#callTimeoutMillis-- – Andrew Puglionesi May 10 '19 at 19:08

score 153 · Answer 2 · edited Dec 04 '19 at 05:48

For okhttp3 this has changed a bit.

Now you set up the times using the builder, and not setters, like this:

OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)
        .writeTimeout(10, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .build();

More info can be found in their wiki: https://github.com/square/okhttp/blob/b3dcb9b1871325248fba917458658628c44ce8a3/docs/recipes.md#timeouts-kt-java

score 12 · Answer 3 · edited Aug 31 '20 at 12:06

For Retrofit retrofit:2.0.0-beta4 the code goes as follows:

OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(logging)
    .connectTimeout(30, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .writeTimeout(30, TimeUnit.SECONDS)
    .build();

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://api.yourapp.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .client(client)
    .build();

score 9 · Answer 4 · edited Aug 31 '20 at 12:06

For Retrofit 2.0.0-beta1 or beta2, the code goes as follows:

OkHttpClient client = new OkHttpClient();

client.setConnectTimeout(30, TimeUnit.SECONDS);
client.setReadTimeout(30, TimeUnit.SECONDS);
client.setWriteTimeout(30, TimeUnit.SECONDS);

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://api.yourapp.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .client(client)
    .build();

score 7 · Answer 5 · edited Sep 01 '20 at 04:53

7

Adding in gradle file and sync project:

compile 'com.squareup.okhttp3:okhttp:3.2.0'
compile 'com.google.code.gson:gson:2.6.2'

Adding in Java class:

import okhttp3.OkHttpClient;
import okhttp3.OkHttpClient.Builder;


Builder b = new Builder();
b.readTimeout(200, TimeUnit.MILLISECONDS);
b.writeTimeout(600, TimeUnit.MILLISECONDS);
// set other properties

OkHttpClient client = b.build();

edited Sep 01 '20 at 04:53

Max Base

639
1
7
15

answered Sep 08 '16 at 05:55

Mohammad nabil

1,010
2
12
23

score 7 · Answer 6 · edited Sep 01 '20 at 08:25

OkHttp Version:3.11.0 or higher

From okhttp source code:

/**
 * Sets the default connect timeout for new connections. A value of 0 means no timeout,
 * otherwise values must be between 1 and {@link Integer#MAX_VALUE} when converted to
 * milliseconds.
 *
 * <p>The connectTimeout is applied when connecting a TCP socket to the target host.
 * The default value is 10 seconds.
 */
public Builder connectTimeout(long timeout, TimeUnit unit) {
    connectTimeout = checkDuration("timeout", timeout, unit);
    return this;
}

unit can be any value of below

TimeUnit.NANOSECONDS
TimeUnit.MICROSECONDS
TimeUnit.MILLISECONDS
TimeUnit.SECONDS
TimeUnit.MINUTES
TimeUnit.HOURS
TimeUnit.DAYS

example code

OkHttpClient client = new OkHttpClient.Builder()
    .connectTimeout(5000, TimeUnit.MILLISECONDS)/*timeout: 5 seconds*/
    .build();

String url = "https://www.google.com";
Request request = new Request.Builder()
    .url(url)
    .build();

try {
    Response response = client.newCall(request).execute();
} catch (IOException e) {
    e.printStackTrace();
}

Updated

I have add new API to OkHttp from version 3.12.0, you can set timeout like this:

OkHttpClient client = new OkHttpClient.Builder()
    .connectTimeout(Duration.ofSeconds(5)) // timeout: 5 seconds
    .build();

NOTE: This requires API 26+ so if you support older versions of Android, continue to use (5, TimeUnit.SECONDS).

score 6 · Answer 7 · edited Apr 19 '18 at 12:13

6

It's changed now. Replace .Builder() with .newBuilder()

As of okhttp:3.9.0 the code goes as follows:

OkHttpClient okHttpClient = new OkHttpClient()
    .newBuilder()
    .connectTimeout(10,TimeUnit.SECONDS)
    .writeTimeout(10,TimeUnit.SECONDS)
    .readTimeout(30,TimeUnit.SECONDS)
    .build();

edited Apr 19 '18 at 12:13

Shreyash Mahajan

23,386
35
116
188

answered Sep 17 '17 at 11:07

Leo

87
1
2

1

This is incorrect. What newBuilder() does is creating a new instance of OkHttpClient that shares the same connection pool, thread pools, and base configuration as the original client, but which can be otherwise configured differently. It is meant to reuse the same shared resources while serving a different specific purpose. For instance, if you need a different client with a shorter timeout. In the end, there's no reason to change new OkHttpClient.Builder() for new OkHttpClient().newBuilder(). Source: https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html – Mickael Bergeron Néron Jun 21 '22 at 04:11

score 4 · Answer 8 · edited Aug 31 '20 at 12:06

4

Like so:

//New Request
HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
logging.setLevel(HttpLoggingInterceptor.Level.BASIC);
final OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(logging)
    .connectTimeout(30, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .writeTimeout(30, TimeUnit.SECONDS)
    .build();

edited Aug 31 '20 at 12:06

Max Base

639
1
7
15

answered Jun 06 '16 at 09:07

Thiago

12,778
14
93
110

score 4 · Answer 9 · edited Aug 31 '20 at 12:09

4

This worked for me:

OkHttpClient client = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)
    .readTimeout(10, TimeUnit.SECONDS)
    .writeTimeout(10, TimeUnit.SECONDS)
    .retryOnConnectionFailure(false) <-- not necessary but useful!
    .build();

Source: https://github.com/square/okhttp/issues/3553

edited Aug 31 '20 at 12:09

Max Base

639
1
7
15

answered Apr 19 '18 at 15:12

rHenderson

608
6
13

it depends on the usecase " <-- not necessary but useful!" – GvSharma Nov 29 '22 at 08:17

score 2 · Answer 10 · edited Aug 31 '20 at 12:05

If you want to customize the configuration then use the below methodology of creating OKhttpclient first and then add builder on top of it.

private final OkHttpClient client = new OkHttpClient();

// Copy to customize OkHttp for this request.
OkHttpClient client1 = client.newBuilder()
    .readTimeout(500, TimeUnit.MILLISECONDS)
    .build();
try (Response response = client1.newCall(request).execute()) {
    System.out.println("Response 1 succeeded: " + response);
} catch (IOException e) {
    System.out.println("Response 1 failed: " + e);
}

score 2 · Answer 11 · answered Jul 17 '19 at 01:20

You can set a call timeout to cover the entire cycle from resolving DNS, connecting, writing the request body, server processing, and reading the response body.

val client = OkHttpClient().newBuilder().callTimeout(CALL_TIMEOUT_IN_MINUTES, TimeUnit.MINUTES).build()

How to set connection timeout with OkHttp

11 Answers11

Updated

Linked

Related