Update documentation to explain redisConnectWithOptions. #1099
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
Additionally document the new `REDIS_OPT_PREFER_IPV4`, `REDIS_OPT_PREFER_IPV6` as well as the rest of our existing options. See #1096
zuiderkwast
reviewed
Sep 2, 2022
| | --- | --- | | ||
| | REDIS\_OPT\_NONBLOCK | Tells hiredis to make a non-blocking connection. | | ||
| | REDIS\_OPT\_REUSEADDR | Tells hiredis to set the [SO_REUSEADDR](https://man7.org/linux/man-pages/man7/socket.7.html) socket option | | ||
| | REDIS\_OPT\_PREFER\_IPV4<br>REDIS\_OPT\_PREFER_IPV6 | Informs hiredis to either prefer `IPV4` or `IPV6` when invoking [getaddrinfo](https://man7.org/linux/man-pages/man3/gai_strerror.3.html). Note that both of the options may be set at once, which will cause hiredis to spcify `AF_UNSPEC` in the getaddrinfo call, which means both `IPV4` and `IPV6` addresses will be searched simultaneously. | |
There was a problem hiding this comment.
Very nice!
We could also add an option like REDIS_OPT_PREFER_IP_UNSPEC which we simply define as REDIS_OPT_PREFER_IPV4 | REDIS_OPT_PREFER_IPV6 and use this in the documentation. WDYT?
There was a problem hiding this comment.
Sure, I can add that.
michael-grunder
added a commit
that referenced
this pull request
Sep 2, 2022
michael-grunder
added a commit
that referenced
this pull request
Sep 2, 2022
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.
Additionally document the new
REDIS_OPT_PREFER_IPV4,REDIS_OPT_PREFER_IPV6as well as the rest of our existing options.See #1096