Retrofit change read timeout for one api call

Question

I want to change the read timeout on OkHttp client using retrofit for one api call. To be clear, I have one end point that can take very long, I need to increase it's timeout and only the timeout for that one api call. Is there a way I can do this through annotations? Is there a way I can do this without changing the timeouts for the rest of the app?

Answer 1

I'm facing a similar situation. I solve my problem providing two Api instances in my ApiModule, each one with your own OkHttpClient. Use @Named to identify each one.

I tried to avoid providing two instances only for a timeout configuration, seems a little strange for me, but since my API instance is a singleton (for performance), I could not see other solution.

Answer 2

You can actually do a per call configuration

Copy the default builder and make another client

private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    Request request = new Request.Builder()
        .url("http://blah_blah_api.com/") // This URL is served with a 1 second delay.
        .build();

    try {
      // Copy to customize OkHttp for this request.
      OkHttpClient copy = client.newBuilder()
          .readTimeout(500, TimeUnit.MILLISECONDS)
          .build();

      Response response = copy.newCall(request).execute();
      System.out.println("Response 1 succeeded: " + response);
    } catch (IOException e) {
      System.out.println("Response 1 failed: " + e);
    }

    try {
      // Copy to customize OkHttp for this request.
      OkHttpClient copy = client.newBuilder()
          .readTimeout(3000, TimeUnit.MILLISECONDS)
          .build();

      Response response = copy.newCall(request).execute();
      System.out.println("Response 2 succeeded: " + response);
    } catch (IOException e) {
      System.out.println("Response 2 failed: " + e);
    }
  }