StashApiClient: Provide descriptions for all timeouts

jenkinsci · Apr 10, 2019 · b1237c0 · b1237c0
1 parent 9759f1d
commit b1237c0
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/stash/StashApiClient.java b/src/main/java/stashpullrequestbuilder/stashpullrequestbuilder/stash/StashApiClient.java
@@ -52,8 +52,15 @@
 @SuppressFBWarnings("EQ_DOESNT_OVERRIDE_EQUALS")
 public class StashApiClient {
 
+  // Request timeout: maximum time between sending an HTTP request and receiving
+  // a response to it from the server.
   private static final int HTTP_REQUEST_TIMEOUT_SECONDS = 60;
+
+  // Connection timeout: maximum time for connecting to the HTTP server.
   private static final int HTTP_CONNECTION_TIMEOUT_SECONDS = 15;
+
+  // Socket timeout: maximum period of inactivity between two data packets
+  // arriving to the client once the connection is established.
   private static final int HTTP_SOCKET_TIMEOUT_SECONDS = 15;
 
   private static final Logger logger =