doc/crypto/BIO_ADDRINFO.pod

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