xref: /freebsd/secure/lib/libcrypto/man/man3/BIO_ADDRINFO.3 (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "BIO_ADDRINFO 3ossl"
BIO_ADDRINFO 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
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
"SYNOPSIS"
Header "SYNOPSIS" .Vb 2 #include <sys/types.h> #include <openssl/bio.h> \& typedef union bio_addrinfo_st BIO_ADDRINFO; \& enum BIO_lookup_type { BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER }; \& int BIO_lookup_ex(const char *host, const char *service, int lookup_type, int family, int socktype, int protocol, BIO_ADDRINFO **res); int BIO_lookup(const char *host, const char *service, enum BIO_lookup_type lookup_type, int family, int socktype, BIO_ADDRINFO **res); \& const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai); int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai); int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai); int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai); const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai); void BIO_ADDRINFO_free(BIO_ADDRINFO *bai); .Ve
"DESCRIPTION"
Header "DESCRIPTION" The \s-1BIO_ADDRINFO\s0 type is a wrapper for address information types provided on your platform.

\fB\s-1BIO_ADDRINFO\s0 normally forms a chain of several that can be picked at one by one.

\fBBIO_lookup_ex() looks up a specified host and service, and uses lookup_type to determine what the default address should be if host is \s-1NULL\s0. family, socktype and protocol are used to determine what protocol family, socket type and protocol should be used for the lookup. family can be any of \s-1AF_INET, AF_INET6, AF_UNIX\s0 and \s-1AF_UNSPEC.\s0 socktype can be \s-1SOCK_STREAM, SOCK_DGRAM\s0 or 0. Specifying 0 indicates that any type can be used. protocol specifies a protocol such as \s-1IPPROTO_TCP, IPPROTO_UDP\s0 or \s-1IPPORTO_SCTP.\s0 If set to 0 than any protocol can be used. res points at a pointer to hold the start of a \s-1BIO_ADDRINFO\s0 chain.

For the family \s-1AF_UNIX\s0, BIO_lookup_ex() will ignore the service parameter and expects the host parameter to hold the path to the socket file.

\fBBIO_lookup() does the same as BIO_lookup_ex() but does not provide the ability to select based on the protocol (any protocol may be returned).

\fBBIO_ADDRINFO_family() returns the family of the given \fB\s-1BIO_ADDRINFO\s0. The result will be one of the constants \s-1AF_INET, AF_INET6\s0 and \s-1AF_UNIX.\s0

\fBBIO_ADDRINFO_socktype() returns the socket type of the given \fB\s-1BIO_ADDRINFO\s0. The result will be one of the constants \s-1SOCK_STREAM\s0 and \s-1SOCK_DGRAM.\s0

\fBBIO_ADDRINFO_protocol() returns the protocol id of the given \fB\s-1BIO_ADDRINFO\s0. The result will be one of the constants \s-1IPPROTO_TCP\s0 and \s-1IPPROTO_UDP.\s0

\fBBIO_ADDRINFO_address() returns the underlying \s-1BIO_ADDR\s0 of the given \s-1BIO_ADDRINFO\s0.

\fBBIO_ADDRINFO_next() returns the next \s-1BIO_ADDRINFO\s0 in the chain from the given one.

\fBBIO_ADDRINFO_free() frees the chain of \s-1BIO_ADDRINFO\s0 starting with the given one.

"RETURN VALUES"
Header "RETURN VALUES" \fBBIO_lookup_ex() and BIO_lookup() return 1 on success and 0 when an error occurred, and will leave an error indication on the OpenSSL error stack in that case.

All other functions described here return 0 or \s-1NULL\s0 when the information they should return isn't available.

"NOTES"
Header "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 \s-1SCTP\s0 based addresses when calling getaddrinfo(). Therefore, if an \s-1SCTP\s0 address is required then the protocol parameter to BIO_lookup_ex() should be explicitly set to \s-1IPPROTO_SCTP.\s0 The same may be true on other platforms.
"HISTORY"
Header "HISTORY" The BIO_lookup_ex() function was added in OpenSSL 1.1.1.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.