From aa4d426b4d3527d7e166df1a05058c9a4a0f6683 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Fri, 30 Apr 2021 00:33:56 +0200 Subject: initial/final commit --- openssl-1.1.0h/doc/crypto/BIO_ADDRINFO.pod | 91 ++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 openssl-1.1.0h/doc/crypto/BIO_ADDRINFO.pod (limited to 'openssl-1.1.0h/doc/crypto/BIO_ADDRINFO.pod') diff --git a/openssl-1.1.0h/doc/crypto/BIO_ADDRINFO.pod b/openssl-1.1.0h/doc/crypto/BIO_ADDRINFO.pod new file mode 100644 index 0000000..7811da4 --- /dev/null +++ b/openssl-1.1.0h/doc/crypto/BIO_ADDRINFO.pod @@ -0,0 +1,91 @@ +=pod + +=head1 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 +- BIO_ADDRINFO type and routines + +=head1 SYNOPSIS + + #include + #include + + typedef union bio_addrinfo_st BIO_ADDRINFO; + + enum BIO_lookup_type { + BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER + }; + int BIO_lookup(const char *node, 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); + +=head1 DESCRIPTION + +The B type is a wrapper for address information +types provided on your platform. + +B normally forms a chain of several that can be +picked at one by one. + +BIO_lookup() looks up a specified B and B, and +uses B to determine what the default address should +be if B is B. B, B are used to +determine what protocol family and protocol should be used for +the lookup. B can be any of AF_INET, AF_INET6, AF_UNIX and +AF_UNSPEC, and B can be SOCK_STREAM or SOCK_DGRAM. +B points at a pointer to hold the start of a B +chain. +For the family B, BIO_lookup() will ignore the B +parameter and expects the B parameter to hold the path to the +socket file. + +BIO_ADDRINFO_family() returns the family of the given +B. The result will be one of the constants +AF_INET, AF_INET6 and AF_UNIX. + +BIO_ADDRINFO_socktype() returns the socket type of the given +B. The result will be one of the constants +SOCK_STREAM and SOCK_DGRAM. + +BIO_ADDRINFO_protocol() returns the protocol id of the given +B. The result will be one of the constants +IPPROTO_TCP and IPPROTO_UDP. + +BIO_ADDRINFO_address() returns the underlying B +of the given B. + +BIO_ADDRINFO_next() returns the next B in the chain +from the given one. + +BIO_ADDRINFO_free() frees the chain of B starting +with the given one. + +=head1 RETURN VALUES + +BIO_lookup() returns 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 B when the +information they should return isn't available. + +=head1 COPYRIGHT + +Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut -- cgit v1.2.3