Fixes #368 Updates javadoc for getRemoteAddr #370
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #368 with javadoc updates for: + reference to RFC 7239 for obtaining local/remote IP and ports + removed historic references to CGI variables + relaxed the dependence on the host header, which may not be present in HTTP/2
Signed-off-by: gregw <gregw@webtide.com>
stuartwdouglas
approved these changes
Oct 12, 2020
markt-asf
approved these changes
Oct 13, 2020
There was a problem hiding this comment.
While it does seem odd to have references to CGI variables in the Javadoc, I have had to rely on CGI spec references in the past to determine correct behaviour. I'm happy for the references to be removed on the understanding that there is no intention to change required behaviour.
|
@markt-asf I removed the CGI references as they were written over a decade ago and who knows if CGI has been update/changed/refined in that time... nor given the RFC7239 nuances we have discussed if they will always be the same value. Thus it felt like it was not worth anything as part of the specification, nor could we really say it was an invariant. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I ended up needing to fix a bit more for #368:
I'm wondering if we should also say anything about [] around IPv6?