BIO_ADDRINFO_family (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/BIO_ADDRINFO_family.3ssl".)

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

SYNOPSIS

 #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(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);

DESCRIPTION

The type is a wrapper for address information types provided on your platform.

normally forms a chain of several that can be picked at one by one.

BIO_lookup() looks up a specified host and service, and uses lookup_type to determine what the default address should be if host is

. family, socktype are used to determine what protocol family and protocol should be used for the lookup. family can be any of and and socktype can be or res points at a pointer to hold the start of a chain. For the family , BIO_lookup() will ignore the service parameter and expects the node parameter to hold the path to the socket file.

BIO_ADDRINFO_family() returns the family of the given

. The result will be one of the constants and

BIO_ADDRINFO_socktype() returns the socket type of the given

. The result will be one of the constants and

BIO_ADDRINFO_protocol() returns the protocol id of the given

. The result will be one of the constants and

BIO_ADDRINFO_address() returns the underlying

of the given .

BIO_ADDRINFO_next() returns the next

in the chain from the given one.

BIO_ADDRINFO_free() frees the chain of

starting with the given one.

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

when the information they should return isn't available.

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

in the source distribution or at <www.openssl.org/source/license.html>.