Skip to content

Add missing Javadoc for ConnectionConfig#820

Merged
garydgregory merged 3 commits intoapache:masterfrom
garydgregory:5.7.x/javadoc_ConnectionConfig
Apr 12, 2026
Merged

Add missing Javadoc for ConnectionConfig#820
garydgregory merged 3 commits intoapache:masterfrom
garydgregory:5.7.x/javadoc_ConnectionConfig

Conversation

@garydgregory
Copy link
Copy Markdown
Member

@garydgregory garydgregory commented Apr 11, 2026

Add missing Javadoc for ConnectionConfig.

* 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY. Done with dbb960a

* </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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, fixed in c38b00f

Copy link
Copy Markdown
Member

@ok2c ok2c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@garydgregory Please squash commits when merging

@garydgregory garydgregory merged commit 0beb0f2 into apache:master Apr 12, 2026
10 checks passed
@garydgregory
Copy link
Copy Markdown
Member Author

Squashed and merged.

@ok2c
Copy link
Copy Markdown
Member

ok2c commented Apr 12, 2026

@garydgregory Please also cherry-pick to 5.6.x

garydgregory added a commit that referenced this pull request Apr 12, 2026
* Add missing Javadoc for ConnectionConfig

* Adjust text after PR review.

* Fix Javadoc typo
@garydgregory
Copy link
Copy Markdown
Member Author

@garydgregory Please also cherry-pick to 5.6.x

Done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants