connection request timeout setting documentation (#1351)

youngxinler · web-flow · commit 28301265cc16 · 2020-12-31T12:07:18.000-05:00
diff --git a/README.md b/README.md
@@ -281,7 +281,10 @@ with the following alterations:
 ---
 ### Customization
 
-Feign has several aspects that can be customized.  For simple cases, you can use `Feign.builder()` to construct an API interface with your custom components.  For example:
+Feign has several aspects that can be customized.  
+For simple cases, you can use `Feign.builder()` to construct an API interface with your custom components.<br>
+For request setting, you can use `options(Request.Options options)` on `target()` to set connectTimeout, connectTimeoutUnit, readTimeout, readTimeoutUnit, followRedirects.<br>
+For example:
 
 ```java
 interface Bank {
@@ -291,8 +294,9 @@ interface Bank {
 
 public class BankService {
   public static void main(String[] args) {
-    Bank bank = Feign.builder().decoder(
-        new AccountDecoder())
+    Bank bank = Feign.builder()
+        .decoder(new AccountDecoder())
+        .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
         .target(Bank.class, "https://api.examplebank.com");
   }
 }
diff --git a/example-github/src/main/java/example/github/GitHubExample.java b/example-github/src/main/java/example/github/GitHubExample.java
@@ -21,6 +21,7 @@
 import feign.gson.GsonEncoder;
 import java.io.IOException;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 import java.util.stream.Collectors;
 
 /** Inspired by {@code com.example.retrofit.GitHubClient} */
@@ -81,6 +82,7 @@ static GitHub connect() {
                     // https://docs.travis-ci.com/user/environment-variables/#defining-encrypted-variables-in-travisyml
                     "Authorization", "token 383f1c1b474d8f05a21e7964976ab0d403fee071");
               })
+          .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
           .target(GitHub.class, "https://api.github.com");
     }
   }
diff --git a/example-wikipedia/src/main/java/example/wikipedia/WikipediaExample.java b/example-wikipedia/src/main/java/example/wikipedia/WikipediaExample.java
@@ -17,14 +17,12 @@
 import com.google.gson.GsonBuilder;
 import com.google.gson.reflect.TypeToken;
 import com.google.gson.stream.JsonReader;
-import feign.Feign;
-import feign.Logger;
-import feign.Param;
-import feign.RequestLine;
+import feign.*;
 import feign.gson.GsonDecoder;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Iterator;
+import java.util.concurrent.TimeUnit;
 
 public class WikipediaExample {
 
@@ -64,6 +62,7 @@ public static void main(String... args) throws InterruptedException {
             .decoder(new GsonDecoder(gson))
             .logger(new Logger.ErrorLogger())
             .logLevel(Logger.Level.BASIC)
+            .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
             .target(Wikipedia.class, "https://en.wikipedia.org");
 
     System.out.println("Let's search for PTAL!");

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`import feign.gson.GsonEncoder;`
`22`	`22`	`import java.io.IOException;`
`23`	`23`	`import java.util.List;`
	`24`	`+import java.util.concurrent.TimeUnit;`
`24`	`25`	`import java.util.stream.Collectors;`
`25`	`26`
`26`	`27`	`/** Inspired by {@code com.example.retrofit.GitHubClient} */`
`@@ -81,6 +82,7 @@ static GitHub connect() {`
`81`	`82`	`// https://docs.travis-ci.com/user/environment-variables/#defining-encrypted-variables-in-travisyml`
`82`	`83`	`"Authorization", "token 383f1c1b474d8f05a21e7964976ab0d403fee071");`
`83`	`84`	`})`
	`85`	`+ .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))`
`84`	`86`	`.target(GitHub.class, "https://api.github.com");`
`85`	`87`	`}`
`86`	`88`	`}`