How to set timeout in Retrofit library

Question

I am using Retrofit library in my app  and I d like to set a timeout of 60 seconds  Does Retrofit have some way to do this    I set Retrofit this way   RestAdapter restAdapter   new RestAdapter Builder        setServer BuildConfig BASE URL       setConverter new GsonConverter gson        build      How can I set the timeout

User · Answer

I found this example  https   github com square retrofit issues 1557  Here we set custom url client connection client before before we build API rest service implementation   import com google gson Gson import com google gson GsonBuilder import retrofit Endpoint import retrofit RestAdapter import retrofit client Request import retrofit client UrlConnectionClient import retrofit converter GsonConverter   class ClientBuilder        public static  lt T gt  T buildClient final Class lt T gt  client  final String serviceUrl            Endpoint mCustomRetrofitEndpoint   new CustomRetrofitEndpoint             Gson gson   new GsonBuilder   excludeFieldsWithoutExposeAnnotation   create           RestAdapter Builder builder   new RestAdapter Builder                setEndpoint mCustomRetrofitEndpoint               setConverter new GsonConverter gson                setClient new MyUrlConnectionClient            RestAdapter restAdapter   builder build           return restAdapter create client            public final class MyUrlConnectionClient extends UrlConnectionClient            Override         protected HttpURLConnection openConnection Request request                HttpURLConnection connection   super openConnection request               connection setConnectTimeout 15   1000               connection setReadTimeout 30   1000               return connection

User · Answer

You can set timeouts on the underlying HTTP client  If you don t specify a client  Retrofit will create one with default connect and read timeouts   To set your own timeouts  you need to configure your own client and supply it to the RestAdapter Builder   An option is to use the OkHttp client  also from Square   1  Add the library dependency  In the build gradle  include this line   compile  com squareup okhttp okhttp x x x    Where x x x is the desired library version   2  Set the client   For example  if you want to set a timeout of 60 seconds  do this way for Retrofit before version 2 and Okhttp before version 3  FOR THE NEWER VERSIONS  SEE THE EDITS    public RestAdapter providesRestAdapter Gson gson        final OkHttpClient okHttpClient   new OkHttpClient        okHttpClient setReadTimeout 60  TimeUnit SECONDS       okHttpClient setConnectTimeout 60  TimeUnit SECONDS        return new RestAdapter Builder            setEndpoint BuildConfig BASE URL           setConverter new GsonConverter gson            setClient new OkClient okHttpClient            build          EDIT 1  For okhttp versions since 3 x x  you have to set the dependency this way   compile  com squareup okhttp3 okhttp x x x    And set the client using the builder pattern   final OkHttpClient okHttpClient   new OkHttpClient Builder            readTimeout 60  TimeUnit SECONDS           connectTimeout 60  TimeUnit SECONDS           build      More info in Timeouts    EDIT 2  Retrofit versions since 2 x x also uses the builder pattern  so change the return block above to this   return new Retrofit Builder        baseUrl BuildConfig BASE URL       addConverterFactory GsonConverterFactory create         client okHttpClient       build      If using a code like my providesRestAdapter method  then change the method return type to Retrofit   More info in Retrofit 2     Upgrade Guide from 1 9     ps  If your minSdkVersion is greater than 8  you can use TimeUnit MINUTES   okHttpClient setReadTimeout 1  TimeUnit MINUTES   okHttpClient setConnectTimeout 1  TimeUnit MINUTES     For more details about the units  see TimeUnit

User · Answer

public class ApiClient       private static Retrofit retrofit   null      private static final Object LOCK   new Object         public static void clear             synchronized  LOCK                retrofit   null                       public static Retrofit getClient             synchronized  LOCK                if  retrofit    null                     Gson gson   new GsonBuilder                            setLenient                            create                     OkHttpClient okHttpClient   new OkHttpClient   newBuilder                            connectTimeout 40  TimeUnit SECONDS                           readTimeout 60  TimeUnit SECONDS                           writeTimeout 60  TimeUnit SECONDS                           build                      retrofit   new Retrofit Builder                            client okHttpClient                           baseUrl Constants WEB SERVICE                           addConverterFactory GsonConverterFactory create gson                            build                              return retrofit                        public static RequestBody plain String content            return getRequestBody  text plain   content              public static RequestBody getRequestBody String type  String content            return RequestBody create MediaType parse type   content             FormUrlEncoded  POST  architect project list Design files   Call lt DesignListModel gt  getProjectDesign           Field  project id   String project id      Multipart  POST  architect upload design   Call lt BoqListModel gt  getUpLoadDesign           Part  user id   RequestBody user id           Part  request id   RequestBody request id           Part List lt MultipartBody Part gt  image file           Part List lt MultipartBody Part gt  design upload doc     private void getMyProjectList          ApiInterface apiService   ApiClient getClient   create ApiInterface class       Call lt MyProjectListModel gt  call   apiService getMyProjectList    Sorting latitude longitude Search Offset    Limit       call enqueue new Callback lt MyProjectListModel gt               Override         public void onResponse Call lt MyProjectListModel gt  call  Response lt MyProjectListModel gt  response                try                   Log e  response  response body                       catch  Exception e                                Log e  onResponse     e toString                                                     Override         public void onFailure Call lt MyProjectListModel gt  call  Throwable t                        Log e   onFailure    t toString                                        file upload  private void getUpload String path String id                 ApiInterface apiService   ApiClient getClient   create ApiInterface class           MultipartBody Part GalleryImage   null          if  path                            File file   new File path               RequestBody reqFile   RequestBody create MediaType parse  multipart form-data    file               GalleryImage   MultipartBody Part createFormData  image   file getName    reqFile                      RequestBody UserId   RequestBody create MediaType parse  text plain    id           Call lt uplod file gt  call   apiService geUplodFileCall UserId GalleryImage           call enqueue new Callback lt uplod file gt                   Override             public void onResponse Call lt uplod file gt  call  Response lt uplod file gt  response                    try                       Log e  response  response body                            Toast makeText getApplicationContext   response body   getMessage   Toast LENGTH SHORT  show                       catch  Exception e                                        Log e  onResponse     e toString                                                  Override             public void onFailure Call lt uplod file gt  call  Throwable t                                Log e   onFailure    t toString                                          implementation  com squareup retrofit2 retrofit 2 4 0      implementation  com squareup retrofit2 converter-gson 2 4 0

User · Answer

For Retrofit1 9 with OkHttp3 users  here is the solution    setClient new Ok3Client new OkHttpClient Builder   readTimeout 60  TimeUnit SECONDS  build

User · Answer

These answers were outdated for me  so here s how it worked out   Add OkHttp  in my case the version is 3 3 1   compile  com squareup okhttp3 okhttp 3 3 1    Then before building your Retrofit  do this   OkHttpClient okHttpClient   new OkHttpClient   newBuilder        connectTimeout 60  TimeUnit SECONDS       readTimeout 60  TimeUnit SECONDS       writeTimeout 60  TimeUnit SECONDS       build    return new Retrofit Builder        baseUrl baseUrl       client okHttpClient       addConverterFactory GsonConverterFactory create         build

User · Answer

public class ApiClient       private static Retrofit retrofit   null      private static final Object LOCK   new Object         public static void clear             synchronized  LOCK                retrofit   null                       public static Retrofit getClient             synchronized  LOCK                if  retrofit    null                     Gson gson   new GsonBuilder                            setLenient                            create                     OkHttpClient okHttpClient   new OkHttpClient   newBuilder                            connectTimeout 40  TimeUnit SECONDS                           readTimeout 60  TimeUnit SECONDS                           writeTimeout 60  TimeUnit SECONDS                           build                        Log e  jjj          MySharedPreference getmInstance   isEnglish     Constant WEB SERVICE   Constant WEB SERVICE ARABIC                    retrofit   new Retrofit Builder                            client okHttpClient                           baseUrl Constants WEB SERVICE                           addConverterFactory GsonConverterFactory create gson                            build                              return retrofit            enter code here              public static RequestBody plain String content            return getRequestBody  text plain   content              public static RequestBody getRequestBody String type  String content            return RequestBody create MediaType parse type   content             -------------------------------------------------------------------------       implementation  com squareup retrofit2 retrofit 2 4 0      implementation  com squareup retrofit2 converter-gson 2 4 0

User · Answer

public class ApiModule       public WebService apiService Context context            String mBaseUrl   context getString BuildConfig DEBUG   R string local url   R string live url            HttpLoggingInterceptor loggingInterceptor   new HttpLoggingInterceptor            loggingInterceptor setLevel BuildConfig DEBUG   HttpLoggingInterceptor Level BODY   HttpLoggingInterceptor Level NONE            OkHttpClient okHttpClient   new OkHttpClient Builder                    readTimeout 120  TimeUnit SECONDS                   writeTimeout 120  TimeUnit SECONDS                   connectTimeout 120  TimeUnit SECONDS                   addInterceptor loggingInterceptor                     addNetworkInterceptor networkInterceptor                   build             return new Retrofit Builder   baseUrl mBaseUrl                   client okHttpClient                   addConverterFactory GsonConverterFactory create                     addCallAdapterFactory RxJavaCallAdapterFactory create                     build   create WebService class

User · Answer

This will be the best way  to set the timeout for each service  passing timeout as parameter   public static Retrofit getClient String baseUrl  int serviceTimeout            Retrofit retrofitselected   baseUrl contains  http      retrofit   retrofithttps          if  retrofitselected    null    retrofitselected equals retrofithttps                 retrofitselected   new Retrofit Builder                        baseUrl baseUrl                       addConverterFactory GsonConverterFactory create getGson   create                          client  BuildConfig FLAVOR equals  PRE     new OkHttpClient Builder                                addInterceptor new ResponseInterceptor                                 connectTimeout serviceTimeout  TimeUnit MILLISECONDS                               writeTimeout serviceTimeout  TimeUnit MILLISECONDS                               readTimeout serviceTimeout  TimeUnit MILLISECONDS                               build     getUnsafeOkHttpClient serviceTimeout                        build                      return retrofitselected          And dont miss this for OkHttpClient   private static OkHttpClient getUnsafeOkHttpClient int serviceTimeout            try                  Create a trust manager that does not validate certificate chains             final TrustManager   trustAllCerts   new TrustManager                         new X509TrustManager                              Override                         public void checkClientTrusted java security cert X509Certificate   chain  String authType  throws CertificateException                                                       Override                         public void checkServerTrusted java security cert X509Certificate   chain  String authType  throws CertificateException                                                       Override                         public java security cert X509Certificate   getAcceptedIssuers                                 return new java security cert X509Certificate                                                                                     Install the all-trusting trust manager             final SSLContext sslContext   SSLContext getInstance  SSL                sslContext init null  trustAllCerts  new java security SecureRandom                    Create an ssl socket factory with our all-trusting manager             final SSLSocketFactory sslSocketFactory   sslContext getSocketFactory                 OkHttpClient Builder builder   new OkHttpClient Builder                builder sslSocketFactory sslSocketFactory               builder hostnameVerifier new HostnameVerifier                      Override                 public boolean verify String hostname  SSLSession session                        return true                                                 OkHttpClient okHttpClient   builder                      addInterceptor new ResponseInterceptor                         connectTimeout serviceTimeout  TimeUnit MILLISECONDS                       writeTimeout serviceTimeout  TimeUnit MILLISECONDS                       readTimeout serviceTimeout  TimeUnit MILLISECONDS                       build                return okHttpClient            catch  Exception e                throw new RuntimeException e                     Hope this will help anyone

User · Answer

I am using Retrofit 1 9 to obtain a XML   public class ServicioConexionRetrofitXML        public static final String API BASE URL   new GestorPreferencias   getPreferencias   getHost        public static final long tiempoMaximoRespuestaSegundos   60      public static final long tiempoMaximoLecturaSegundos   100      public static final OkHttpClient clienteOkHttp   new OkHttpClient          private static RestAdapter Builder builder   new RestAdapter Builder                setEndpoint API BASE URL               setClient new OkClient clienteOkHttp   setConverter new SimpleXMLConverter           public static  lt S gt  S createService Class lt S gt  serviceClass            clienteOkHttp setConnectTimeout tiempoMaximoRespuestaSegundos  TimeUnit SECONDS           clienteOkHttp setReadTimeout tiempoMaximoLecturaSegundos  TimeUnit SECONDS           RestAdapter adapter   builder build            return adapter create serviceClass              If you are using Retrofit 1 9 0 and okhttp 2 6 0  add to your Gradle file       compile  com squareup retrofit retrofit 1 9 0      compile  com squareup okhttp okhttp 2 6 0         Librer  a de retrofit para XML converter  Simple  Se excluyen grupos para que no entre        en conflicto      compile  com squareup retrofit converter-simplexml 1 9 0             exclude group   xpp3   module   xpp3          exclude group   stax   module   stax-api          exclude group   stax   module   stax          Note  If you need to fetch a JSON  just remove from code above    setConverter new SimpleXMLConverter

[java] How to set timeout in Retrofit library?

Examples related to java

Examples related to android

Examples related to timeout

Examples related to retrofit