Fix doc-nits issue
[openssl.git] / doc / man3 / BIO_ADDRINFO.pod
index 45e6e05761c2e1d2b092218674df498dabc2c73a..8ca6454abbcb2a15ef00a10d537803e362404ea6 100644 (file)
@@ -6,6 +6,7 @@ BIO_lookup_type,
 BIO_ADDRINFO, BIO_ADDRINFO_next, BIO_ADDRINFO_free,
 BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol,
 BIO_ADDRINFO_address,
+BIO_lookup_ex,
 BIO_lookup
 - BIO_ADDRINFO type and routines
 
@@ -52,7 +53,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 +90,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.