[v2] misc: make uv_ip4_addr()/uv_ip6_addr() accept an unsigned short port instead of int
#4130
+14
−10
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
Change the `port` parameter of `uv_ip4_addr()` and `uv_ip6_addr()` from
an `int` to an `unsigned short`.
Currently, the `uv_ip4_addr()` and `uv_ip6_addr()` functions cast the
`port` to a `uint16_t` internally anyway, when calling [`htons()`][1].
Making the function accept `unsigned short` instead has two benefits:
- Very slight performance increase, since we can avoid a
`unsigned short` -> `int` -> `unsigned short` conversion.
- Compilers can warn users of `libuv` if their `port` parameter
to `uv_ip4_addr()` might be truncated.
BREAKING CHANGE: This change breaks the ABI, but it does not break the
API (other than potentially causing some compiler
warnings if the user calls this function with
overflowing types).
[1]: https://linux.die.net/man/3/htons
|
I am somewhat inclined to suggest making it an |
Going from I'm not too fussed if this change is pushed back until v2 (even if v2 never comes out) if you don't want to take the risk of breaking the ABI on a weird system. It is pretty minor after all! |
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.
Change the
portparameter ofuv_ip4_addr()anduv_ip6_addr()from anintto anunsigned short.Currently, the
uv_ip4_addr()anduv_ip6_addr()functions cast theportto auint16_tinternally anyway, when callinghtons().Making the function accept
unsigned shortinstead has two benefits:unsigned short->int->unsigned shortconversion.libuvif theirportparameter touv_ip4_addr()might be truncated.ABI BREAKING CHANGE: This PR targets the
master/v2 branch, as this change breaks the ABI. Although, it does not break the API (other than potentially causing some compiler warnings if the user calls this function with overflowing types), so I haven't bothered putting a message into the libuv v1 -> v2 migration guide.The
CI-docsCI will probably fail due to a broken link that's unrelated to this PR.It's already been fixed in the
v1.xbranch thanks to PR #4128, but this PR targets themasterbranch, which doesn't yet have this fix.