How to set timeout in Retrofit-2.0+ android

Question

I referred this link but I can't seem to implement for mine

I am using

 compile 'com.squareup.retrofit2:retrofit:2.0.2'
 compile 'com.squareup.retrofit2:converter-gson:2.0.2'

I am using the below code, How to set timeout for this !

public class ApiClient {

    public static final String BASE_URL = Constants.BaseURL;
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit==null) {
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

Alex Chengalan · Accepted Answer · 2018-10-01T03:50:28.137

100

Configure OkHttpClient for timeout option. Then use this as client for Retrofit.Builder.

final OkHttpClient okHttpClient = new OkHttpClient.Builder()
    .connectTimeout(20, TimeUnit.SECONDS)
    .writeTimeout(20, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .build();

Use this okHttpClient for Retrofit#Builder

Retrofit.Builder()
    .client(okHttpClient);

Official OkHttp documentation about timeout is here

edited Oct 01 '18 at 03:50

answered May 11 '16 at 12:15

Alex Chengalan

8,211
4
42
56

what is the difference between connect, write and read time out? thank you :) – ladytoky0 May 14 '22 at 00:40
2

Connect Timeout - The maximum time in making the initial connection to the server. Write Timeout - The maximum time you allow to write (send) the request data to the service. Read Timeout - The time you wait for the response. @ladytoky0 Hope this helps you :) – Alex Chengalan May 16 '22 at 06:18
1

thank you very much! so much clear now :D – ladytoky0 May 16 '22 at 20:28

score 8 · Answer 2 · answered May 11 '16 at 12:06

try below code, it sét timeout is 20 seconds and readTimeout is 30 seconds

 private OkHttpClient getRequestHeader() {
        OkHttpClient httpClient = new OkHttpClient();
        httpClient.setConnectTimeout(20, TimeUnit.SECONDS);
        httpClient.setReadTimeout(30, TimeUnit.SECONDS);

        return httpClient;
    }

Then

public class ApiClient {

    public static final String BASE_URL = Constants.BaseURL;
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit==null) {
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(getRequestHeader())
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
        }
    }

I'm curious why you named your method `getRequestHeader()`? I'd suggest `getHttpClient()` would be a better name. — k2col, Sep 03 '17 at 19:20
I am getting setConnectTimeout() & setReadTimeout() can't be resolved. Imported package okhttp3.OkHttpClient. Please help me, i am new to retrofit/okhttp — VVB, Sep 07 '17 at 07:51

score 1 · Answer 3 · answered May 16 '20 at 03:42

I have used bellow like in Kotlin with MVVM Model..

var okHttpClient: OkHttpClient? = OkHttpClient.Builder()
    .connectTimeout(60, TimeUnit.SECONDS)
    .readTimeout(60, TimeUnit.SECONDS)
    .writeTimeout(60, TimeUnit.SECONDS)
    .build()

private val api = Retrofit.Builder()
    .baseUrl(baseurl)
    .addConverterFactory(GsonConverterFactory.create())
    .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
    .client(okHttpClient)
    .build()
    .create(Api::class.java);

score 0 · Answer 4 · edited Jul 31 '18 at 08:58

0

If you are using "com.squareup.retrofit2:retrofit:2.4.0" retrofit version > 2 then you try this one:

private OkHttpClient getRequestHeader() 
{
    OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .readTimeout(60, TimeUnit.SECONDS)
        .connectTimeout(60, TimeUnit.SECONDS)
        .writeTimeout(20, TimeUnit.SECONDS)
        .build();

    return okHttpClient;
}

edited Jul 31 '18 at 08:58

pritaeas

2,073
5
34
51

answered Jul 31 '18 at 06:55

Purushottam Kumar

1

Marawan Mamdouh · Answer 5 · 2022-09-01T15:04:22.187

In Kotlin you can Configure timeout for Retrofit by

Create OkHttpClient object with time in seconds (The default value is 10 seconds)

private val okHttpClient = OkHttpClient.Builder()
    .connectTimeout(30, TimeUnit.SECONDS)
    .writeTimeout(30, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .build()

Then use this object for Retrofit Builder

private val retrofit = Retrofit.Builder()
    .addConverterFactory(ScalarsConverterFactory.create())
    .client(okHttpClient)
    .baseUrl(BASE_URL)
    .build()

And import these

import java.util.concurrent.TimeUnit
import okhttp3.OkHttpClient
import retrofit2.Retrofit

How to set timeout in Retrofit-2.0+ android

5 Answers5

In Kotlin you can Configure timeout for Retrofit by

Linked