Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc about HttpClient.ResponseReceiver.response() method need to update. #1607

Closed
ctlove0523 opened this issue Apr 20, 2021 · 0 comments · Fixed by #1608
Closed

Javadoc about HttpClient.ResponseReceiver.response() method need to update. #1607

ctlove0523 opened this issue Apr 20, 2021 · 0 comments · Fixed by #1608
Labels
type/documentation A documentation update
Milestone

Comments

@ctlove0523
Copy link
Contributor

Current javadoc about this method:

Return the response status and headers as HttpClientResponse
Will automatically close the response if necessary.

Returns:
the response status and headers as HttpClientResponse

from this javadoc user may think reactor netty will auto close http response,but in fact reactor netty do more works: close the low-level network connection which transfer the request. A question about this from stackoverflowHow to make sure rector netty http client create fix connection to http server.In order to let user learn more about this method behavior,i suggest update this javadoc.

Updated javadoc may like this:

Return the response status and headers as HttpClientResponse
Will automatically close the response if necessary.
Note:this method will close low-level network connection.

Returns:
the response status and headers as HttpClientResponse

Any suggestions are welcome.

@ctlove0523 ctlove0523 added status/need-triage A new issue that still need to be evaluated as a whole type/enhancement A general enhancement labels Apr 20, 2021
@violetagg violetagg removed the status/need-triage A new issue that still need to be evaluated as a whole label Apr 20, 2021
@violetagg violetagg added this to the 1.0.7 milestone Apr 20, 2021
@simonbasle simonbasle added type/documentation A documentation update and removed type/enhancement A general enhancement labels Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants