45e6e05761c2e1d2b092218674df498dabc2c73a
[openssl.git] / doc / man3 / BIO_ADDRINFO.pod
1 =pod
2
3 =head1 NAME
4
5 BIO_lookup_type,
6 BIO_ADDRINFO, BIO_ADDRINFO_next, BIO_ADDRINFO_free,
7 BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol,
8 BIO_ADDRINFO_address,
9 BIO_lookup
10 - BIO_ADDRINFO type and routines
11
12 =head1 SYNOPSIS
13
14  #include <sys/types.h>
15  #include <openssl/bio.h>
16
17  typedef union bio_addrinfo_st BIO_ADDRINFO;
18
19  enum BIO_lookup_type {
20      BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
21  };
22
23  int BIO_lookup_ex(const char *host, const char *service, int lookup_type,
24                    int family, int socktype, int protocol, BIO_ADDRINFO **res);
25  int BIO_lookup(const char *node, const char *service,
26                 enum BIO_lookup_type lookup_type,
27                 int family, int socktype, BIO_ADDRINFO **res);
28
29  const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
30  int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
31  int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
32  int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
33  const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
34  void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
35
36 =head1 DESCRIPTION
37
38 The B<BIO_ADDRINFO> type is a wrapper for address information
39 types provided on your platform.
40
41 B<BIO_ADDRINFO> normally forms a chain of several that can be
42 picked at one by one.
43
44 BIO_lookup_ex() looks up a specified B<host> and B<service>, and
45 uses B<lookup_type> to determine what the default address should
46 be if B<host> is B<NULL>. B<family>, B<socktype> and B<protocol> are used to
47 determine what protocol family, socket type and protocol should be used for
48 the lookup.  B<family> can be any of AF_INET, AF_INET6, AF_UNIX and
49 AF_UNSPEC. B<socktype> can be SOCK_STREAM, SOCK_DGRAM or 0. Specifying 0
50 indicates that any type can be used. B<protocol> specifies a protocol such as
51 IPPROTO_TCP, IPPROTO_UDP or IPPORTO_SCTP. If set to 0 than any protocol can be
52 used. B<res> points at a pointer to hold the start of a B<BIO_ADDRINFO>
53 chain.
54
55 For the family B<AF_UNIX>, BIO_lookup() will ignore the B<service>
56 parameter and expects the B<node> parameter to hold the path to the
57 socket file.
58
59 BIO_lookup() does the same as BIO_lookup_ex() but does not provide the ability
60 to select based on the protocol (any protocol may be returned).
61
62 BIO_ADDRINFO_family() returns the family of the given
63 B<BIO_ADDRINFO>.  The result will be one of the constants
64 AF_INET, AF_INET6 and AF_UNIX.
65
66 BIO_ADDRINFO_socktype() returns the socket type of the given
67 B<BIO_ADDRINFO>.  The result will be one of the constants
68 SOCK_STREAM and SOCK_DGRAM.
69
70 BIO_ADDRINFO_protocol() returns the protocol id of the given
71 B<BIO_ADDRINFO>.  The result will be one of the constants
72 IPPROTO_TCP and IPPROTO_UDP.
73
74 BIO_ADDRINFO_address() returns the underlying B<BIO_ADDR>
75 of the given B<BIO_ADDRINFO>.
76
77 BIO_ADDRINFO_next() returns the next B<BIO_ADDRINFO> in the chain
78 from the given one.
79
80 BIO_ADDRINFO_free() frees the chain of B<BIO_ADDRINFO> starting
81 with the given one.
82
83 =head1 RETURN VALUES
84
85 BIO_lookup_ex() and BIO_lookup() return 1 on success and 0 when an error
86 occurred, and will leave an error indication on the OpenSSL error stack in that
87 case.
88
89 All other functions described here return 0 or B<NULL> when the
90 information they should return isn't available.
91
92 =head1 HISTORY
93
94 The BIO_lookup_ex() function was added in OpenSSL 1.1.1.
95
96 =head1 COPYRIGHT
97
98 Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
99
100 Licensed under the OpenSSL license (the "License").  You may not use
101 this file except in compliance with the License.  You can obtain a copy
102 in the file LICENSE in the source distribution or at
103 L<https://www.openssl.org/source/license.html>.
104
105 =cut