diff options
author | Matt Caswell <matt@openssl.org> | 2017-04-24 14:15:49 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2017-04-25 11:13:39 +0100 |
commit | 561f6f1ed237cb9a5a9020e58a368dd9d351b40b (patch) | |
tree | 3bc069588f851326eb99b1832caf0d6ed641e799 /doc/man3/BIO_ADDRINFO.pod | |
parent | ce466c96f0eb14e5c35181e54e52164de1afe921 (diff) |
Address review feedback for the SCTP changes
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3286)
Diffstat (limited to 'doc/man3/BIO_ADDRINFO.pod')
-rw-r--r-- | doc/man3/BIO_ADDRINFO.pod | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/man3/BIO_ADDRINFO.pod b/doc/man3/BIO_ADDRINFO.pod index 45e6e05761..37a3e6244c 100644 --- a/doc/man3/BIO_ADDRINFO.pod +++ b/doc/man3/BIO_ADDRINFO.pod @@ -52,7 +52,7 @@ IPPROTO_TCP, IPPROTO_UDP or IPPORTO_SCTP. If set to 0 than any protocol can be used. B<res> points at a pointer to hold the start of a B<BIO_ADDRINFO> chain. -For the family B<AF_UNIX>, BIO_lookup() will ignore the B<service> +For the family B<AF_UNIX>, BIO_lookup_ex() will ignore the B<service> parameter and expects the B<node> parameter to hold the path to the socket file. @@ -89,6 +89,14 @@ case. All other functions described here return 0 or B<NULL> when the information they should return isn't available. +=head1 NOTES + +The BIO_lookup_ex() implementation uses the platform provided getaddrinfo() +function. On Linux it is known that specifying 0 for the protocol will not +return any SCTP based addresses when calling getaddrinfo(). Therefore if an SCTP +address is required then the B<protocol> parameter to BIO_lookup_ex() should be +explicitly set to IPPROTO_SCTP. The same may be true on other platforms. + =head1 HISTORY The BIO_lookup_ex() function was added in OpenSSL 1.1.1. |