You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by "garydgregory (via GitHub)" <gi...@apache.org> on 2026/04/11 12:55:32 UTC

[PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

garydgregory opened a new pull request, #820:
URL: https://github.com/apache/httpcomponents-client/pull/820

   (no comment)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "ok2c (via GitHub)" <gi...@apache.org>.
ok2c commented on code in PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#discussion_r3068463268


##########
httpclient5/src/main/java/org/apache/hc/client5/http/config/ConnectionConfig.java:
##########
@@ -74,34 +84,56 @@ protected ConnectionConfig() {
     }
 
     /**
+     * Gets the default socket timeout value for I/O operations on connections created by this configuration.
+     * A timeout value of zero is interpreted as an infinite timeout.
+     *
+     * @return the default socket timeout value, defaults to null.
      * @see Builder#setSocketTimeout(Timeout)
      */
     public Timeout getSocketTimeout() {
         return socketTimeout;
     }
 
     /**
+     * Gets the timeout until a new connection is fully established.
+     * <p>
+     * A timeout value of zero is interpreted as an infinite timeout.
+     * </p>
+     *
+     * @return the timeout until a new connection is fully established, defaults to 3 minutes.

Review Comment:
   @garydgregory  Can we re-phrase this statement a little? Technically the connection timeout is a timeout until the target endpoint acknowledgement it accepts the connection request, not until the new connection is fully established. For instance an HTTPS connection cannot be considered fully established until the TLS handshake has been successfully completed.
   
   Very nice otherwise. 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory merged PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory commented on code in PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#discussion_r3068484813


##########
httpclient5/src/main/java/org/apache/hc/client5/http/config/ConnectionConfig.java:
##########
@@ -74,34 +84,56 @@ protected ConnectionConfig() {
     }
 
     /**
+     * Gets the default socket timeout value for I/O operations on connections created by this configuration.
+     * A timeout value of zero is interpreted as an infinite timeout.
+     *
+     * @return the default socket timeout value, defaults to null.
      * @see Builder#setSocketTimeout(Timeout)
      */
     public Timeout getSocketTimeout() {
         return socketTimeout;
     }
 
     /**
+     * Gets the timeout until a new connection is fully established.
+     * <p>
+     * A timeout value of zero is interpreted as an infinite timeout.
+     * </p>
+     *
+     * @return the timeout until a new connection is fully established, defaults to 3 minutes.

Review Comment:
   TY. Done with https://github.com/apache/httpcomponents-client/pull/820/changes/dbb960a5565ebb1c0bc4d788ad24f26b7b59fa91
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory commented on PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#issuecomment-4231449181

   Squashed and merged.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "ok2c (via GitHub)" <gi...@apache.org>.
ok2c commented on PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#issuecomment-4231489720

   @garydgregory Please also cherry-pick to `5.6.x`


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "ok2c (via GitHub)" <gi...@apache.org>.
ok2c commented on code in PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#discussion_r3069250541


##########
httpclient5/src/main/java/org/apache/hc/client5/http/config/ConnectionConfig.java:
##########
@@ -95,12 +95,16 @@ public Timeout getSocketTimeout() {
     }
 
     /**
-     * Gets the timeout until a new connection is fully established.
+     * Gets the timeout until the target endpoint acknowledges accepting the connection request.
+     * <p>
+     * Note that isn't the same time as the new connection being fully established. An HTTPS connection cannot be considered fully established until the TLS
+     * handshake has been successfully completed.
+     * </p>
      * <p>
      * A timeout value of zero is interpreted as an infinite timeout.
      * </p>
      *
-     * @return the timeout until a new connection is fully established, defaults to 3 minutes.
+     * @return the ttimeout until the target endpoint acknowledges accepting the connection request, defaults to 3 minutes.

Review Comment:
   @garydgregory Typo



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory commented on code in PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#discussion_r3069357395


##########
httpclient5/src/main/java/org/apache/hc/client5/http/config/ConnectionConfig.java:
##########
@@ -95,12 +95,16 @@ public Timeout getSocketTimeout() {
     }
 
     /**
-     * Gets the timeout until a new connection is fully established.
+     * Gets the timeout until the target endpoint acknowledges accepting the connection request.
+     * <p>
+     * Note that isn't the same time as the new connection being fully established. An HTTPS connection cannot be considered fully established until the TLS
+     * handshake has been successfully completed.
+     * </p>
      * <p>
      * A timeout value of zero is interpreted as an infinite timeout.
      * </p>
      *
-     * @return the timeout until a new connection is fully established, defaults to 3 minutes.
+     * @return the ttimeout until the target endpoint acknowledges accepting the connection request, defaults to 3 minutes.

Review Comment:
   Good catch, fixed in c38b00f8e33c80602e6a2438b8d1123113fee0dc



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Re: [PR] Add missing Javadoc for ConnectionConfig [httpcomponents-client]

Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory commented on PR #820:
URL: https://github.com/apache/httpcomponents-client/pull/820#issuecomment-4231548646

   > @garydgregory Please also cherry-pick to `5.6.x`
   
   Done!
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org